From sarah.goslee at gmail.com  Thu Dec 15 14:21:36 2011
From: sarah.goslee at gmail.com (Sarah Goslee)
Date: Thu, 15 Dec 2011 08:21:36 -0500
Subject: [Rd] Undocumented functions
In-Reply-To: <CAM8ViJPmS_zJzsT54ymj7OZOFUXAKwsCz=Qs9ckk2ESLrr-mrw@mail.gmail.com>
References: <CAM8ViJPmS_zJzsT54ymj7OZOFUXAKwsCz=Qs9ckk2ESLrr-mrw@mail.gmail.com>
Message-ID: <CAM_vjuk+785BXXXFK0+LcG53WaRL39J4FBbXXaFjLPFpn494Lw@mail.gmail.com>

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
<mailinglist at nicolasturaro.com> wrote:
> 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?
>
> Thank you very much for help.
>
> Sincerely,
> Nicola

-- 
Sarah Goslee
http://www.functionaldiversity.org



[Rd] Undocumented functions
Sarah Goslee