package functions documentation
The "Writing R extensions" pdf says the following on the matter: Note that all user-level ob jects in a package should be documented; if a package pkg contains user-level objects which are for ?internal? use only, it should provide a file ?pkg-internal.Rd? which documents all such objects, and clearly states that these are not meant to be called by the user. See e.g. the sources for package grid in the R distribution for an example. Note that packages which use internal objects extensively should hide those objects in a name space, when they do not need to be documented (see Section 1.6 [Package name spaces], page 19). Of course, the message is only a warning after all, so you could simply ignore it ;). Haris Skiadas Department of Mathematics and Computer Science Hanover College
On May 27, 2008, at 9:30 AM, Ardia David wrote:
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