[Rd] Undocumented functions

Ben Bolker bbolker at gmail.com
Thu Dec 15 14:05:43 CET 2011

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 know that all user-level functions should be documented, so I have to
> move my undocumented functions to a non-user-level. It's right?
> To move my functions to a non-user-level I can write them as hidden
> functions, with a dot before the names. This require a very long check of
> my code to change the call to the function preceding it by a dot. So, this
> is not a real choice.
> There are other way to reach my purpose?

  Read about name spaces; search for NAMESPACE or "name space" in the 
R extensions manual.
  Any function that is not exported from a package need not be documented.

  Ben Bolker

More information about the R-devel mailing list