[R] A chinese R-info page and a question

[Thomas Lumley]

On Fri, 9 Nov 2001, Mai Zhou wrote:

> Now I have a question: I am packaging several functions doing
> empirical likelihood ratio as an R package.
>
> Using R CMD check emplik,
> There is warning about undocumented functions.
>
> Those are "utility functions" used by the main function.
> What do I suppose to do for those functions? where do I document them?
>
> I do not think they warrant a full document like the regular function.

The solution (in 'Writing R Extension' section 1.1.3 for version 1.3.1) is
to have a single 'internals' page for each package that lists all
these functions.  For an example, do
  library(ts)
  help("ts-internal")
This confirms that you haven't just forgotten to document these functions.

	-thomas

Thomas Lumley			Asst. Professor, Biostatistics
tlumley at u.washington.edu	University of Washington, Seattle

-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
r-help mailing list -- Read http://www.ci.tuwien.ac.at/~hornik/R/R-FAQ.html
Send "info", "help", or "[un]subscribe"
(in the "body", not the subject !)  To: r-help-request at stat.math.ethz.ch
_._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._