Re: [R] package functions documentation

From: Søren Højsgaard <Soren.Hojsgaard_at_agrsci.dk>
Date: Tue, 27 May 2008 15:41:22 +0200

You can create a myPackage-internal.Rd file where you only have to list the functions using \alias{}; see page 7 in "Writing R extensions". Function names starting with a "." are (currently) not detected in the check, so using .foo etc. for internals might be an option as well. Regards
Søren


Fra: r-help-bounces_at_r-project.org på vegne af Ardia David Sendt: ti 27-05-2008 15:30
Til: R-help_at_r-project.org
Emne: [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.
______________________________________________
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 - 14:48:55 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 Tue 27 May 2008 - 17:30:40 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