Re: [Rd] Undocumented functions

From: Ben Bolker <bbolker_at_gmail.com>
Date: Thu, 15 Dec 2011 13:05:43 +0000

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



R-devel_at_r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel Received on Thu 15 Dec 2011 - 13:09:29 GMT

This quarter's messages: by month, or sorted: [ by date ] [ by thread ] [ by subject ] [ by author ]

All messages

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 Thu 15 Dec 2011 - 13:30:17 GMT.

Mailing list information is available at https://stat.ethz.ch/mailman/listinfo/r-devel. Please read the posting guide before posting to the list.

list of date sections of archive