From bbolker at gmail.com  Thu Dec 15 14:05:43 2011
From: bbolker at gmail.com (Ben Bolker)
Date: Thu, 15 Dec 2011 13:05:43 +0000
Subject: [Rd] Undocumented functions
References: <CAM8ViJPmS_zJzsT54ymj7OZOFUXAKwsCz=Qs9ckk2ESLrr-mrw@mail.gmail.com>
Message-ID: <loom.20111215T140454-155@post.gmane.org>

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



[Rd] Undocumented functions
Ben Bolker