[R] package functions documentation

[Doran, Harold]

If this is for distribution on CRAN, you should have documentation for
all functions. But, if these are "minor" functions and are used only to
support the "major" functions I see two ways you could resolve this.

1) First option is to embed the minor functions within the major
functions they support so that they do not exist globally.
2) You could delete the Rd-files for the minor functions in the "man"
folder and then write a namespace file where you define the major
functions which should be visible and save it in your package folder
before you do R CMD stuff.


> -----Original Message-----
> From: r-help-bounces at r-project.org 
> [mailto:r-help-bounces at r-project.org] On Behalf Of Ardia David
> Sent: Tuesday, May 27, 2008 9:30 AM
> To: R-help at r-project.org
> Subject: [R] package functions documentation
> 
> 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.
> --
> 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.
>