[R] package functions documentation

[Martin Morgan]

Ardia David <david.ardia at unifr.ch> writes:

> Great, thanks a lot! It works properly now.
> By the way, how can I get rid of the warning message :
>
> * checking line endings in C/C++/Fortran sources/headers ... WARNING
> Found the following sources/headers with CR or CRLF line endings:
>
> Should I open an save the C files in another format ? I am using
> notepad on a Windows XP machine.

Change formats yes. With Notepad, I don't think you can. There are
hints at

http://en.wikipedia.org/wiki/Newline#Conversion_utilities

Martin

>
> Martin Morgan wrote:
>> Ardia David <david.ardia at unifr.ch> writes:
>> 
>>> Dear all,
>>> I am currently creating a package and writing the documention files
>>> for some functions (the main functions). When using R CMD check
>>> myPackage, I get a warning message indicating that some of my
>>> functions are not documented. How can I get rid of this problem? Of
>>> course, I don't want to document every function in the package...
>>> Thanks for your help.
>> Adding a NAMESPACE file to your package allows you to separate
>> functions that are visible to the end user (and hence requiring
>> documentation) from those used purely internally to the package (and
>> perhaps documented less formally). See the Writing R Extensions manual
>> for details.
>> This helps to provide the user with access to the relevant
>> documentation, without too much clutter. It also helps you to
>> structure your code to have a 'public' interface that should be
>> well thought out and relatively unchanging, and more flexibly defined
>> and used functions that are 'private' to your package.
>> Martin
>>> -- 
>>> David Ardia
>>> H-building, room 11-26
>>> Econometric Institute
>>> Erasmus University
>>> PO Box 1738
>>> NL 3000 DR Rotterdam
>>> The Netherlands
>>> Phone: +31 (0)10 408 2269
>>>
>>> ______________________________________________
>>> R-help at r-project.org mailing list
>>> https://stat.ethz.ch/mailman/listinfo/r-help
>>> PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
>>> and provide commented, minimal, self-contained, reproducible code.
>> 
>
> -- 
> David Ardia
> H-building, room 11-26
> Econometric Institute
> Erasmus University
> PO Box 1738
> NL 3000 DR Rotterdam
> The Netherlands
> Phone: +31 (0)10 408 2269

-- 
Martin Morgan
Computational Biology / Fred Hutchinson Cancer Research Center
1100 Fairview Ave. N.
PO Box 19024 Seattle, WA 98109

Location: Arnold Building M2 B169
Phone: (206) 667-2793