Re: [Rd] Undocumented functions

2011-12-16 Thread David Scott
One easy way is to list the undocumented files in pkg-internal.Rd. From the Writing R Extensions manual: Note that all user-level objects 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

Re: [Rd] Undocumented functions

2011-12-16 Thread Martin Maechler
David Scott d.sc...@auckland.ac.nz on Fri, 16 Dec 2011 22:51:11 +1300 writes: One easy way is to list the undocumented files in pkg-internal.Rd. From the Writing R Extensions manual: Note that all user-level objects in a package should be documented; if a package pkg

Re: [Rd] Undocumented functions

2011-12-16 Thread Nicola Sturaro Sommacal
Thanks to all! Nicola 2011/12/16 Martin Maechler maech...@stat.math.ethz.ch David Scott d.sc...@auckland.ac.nz on Fri, 16 Dec 2011 22:51:11 +1300 writes: One easy way is to list the undocumented files in pkg-internal.Rd. From the Writing R Extensions manual: Note that

[Rd] Undocumented functions

2011-12-15 Thread Nicola Sturaro Sommacal
Hi! I am building a package. This package will not submitted to CRAN. I write the help files for the most important functions of my package, I cannot write it for all functions. This may sounds strange, but so there! I know that all user-level functions should be documented, so I have to move

Re: [Rd] Undocumented functions

2011-12-15 Thread Ben Bolker
Nicola Sturaro Sommacal mailinglist at nicolasturaro.com writes: Hi! I am building a package. This package will not submitted to CRAN. I write the help files for the most important functions of my package, I cannot write it for all functions. This may sounds strange, but so there! I

Re: [Rd] Undocumented functions

2011-12-15 Thread Joris Meys
Use namespaces and only export the functions at the user level. The rest will be hidden in the namespace and doesn't require a help page. See 'Package Namespaces' in the manual Writing R Extensions. Cheers On Thu, Dec 15, 2011 at 1:01 PM, Nicola Sturaro Sommacal mailingl...@nicolasturaro.com

Re: [Rd] Undocumented functions

2011-12-15 Thread Sarah Goslee
Why not use package.skeleton() to construct empty help files? But if you're determined to change the function names instead, grep and sed are very useful tools for that sort of thing. (The OS versions, not the R grep()). Sarah On Thu, Dec 15, 2011 at 7:01 AM, Nicola Sturaro Sommacal