Re: [R] package functions documentation

From: Ardia David <david.ardia_at_unifr.ch>
Date: Tue, 27 May 2008 17:19:12 +0200

Great, thanks a lot! It works properly now. By the way, how can I get rid of the warning message :

Should I open an save the C files in another format ? I am using notepad on a Windows XP machine.

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

______________________________________________
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.
Received on Tue 27 May 2008 - 17:27:03 GMT

Archive maintained by Robert King, hosted by the discipline of statistics at the University of Newcastle, Australia.
Archive generated by hypermail 2.2.0, at Wed 28 May 2008 - 14:30:41 GMT.

Mailing list information is available at https://stat.ethz.ch/mailman/listinfo/r-help. Please read the posting guide before posting to the list.

list of date sections of archive