Re: [R] Hiding internal package functions for the doc. pkg-internal.Rd

About this list Date view Thread view Subject view Author view Attachment view

From: Henrik Bengtsson (hb@maths.lth.se)
Date: Tue 25 May 2004 - 19:48:31 EST


Message-id: <Pine.LNX.4.53.0405251144510.31403@markov.maths.lth.se>

Add \keyword{internal} to the Rd files you would like to hide from the
index. From section "Documenting functions" in "Writing R Extensions" (for
R v1.9.0):

"\keyword{key}
  Each \keyword entry should specify one of the standard keywords (as
listed in the file R_HOME/doc/KEYWORDS.db). There must be at least one
\keyword entry, but can be more that one if the R object being documented
falls into more than one category.

 The special keyword 'internal' marks a page of internal objects that are
not part of the packages' API. If the help page for object foo has keyword
internal, then help(foo) gives this help page, but foo is excluded from
several object indices, like the alphabetical list of objects in the HTML
help system."

Cheers

Henrik Bengtsson

Dept. of Mathematical Statistics @ Centre for Mathematical Sciences
Lund Institute of Technology/Lund University, Sweden (+2h UTC)
+46 46 2229611 (off), +46 708 909208 (cell), +46 46 2224623 (fax)
h b @ m a t h s . l t h . s e, http://www.maths.lth.se/~hb/

On Tue, 25 May 2004, Wolski wrote:

> Hallo!
>
> I would like that the internal package functions does not appear in the documentation.
> I placed they names as aliases in the file nameofmypackage-internal.Rd as advised.
>
> After R CMD check (which runs neatly) they are still listed in 00Index.html.
>
> Is there no way to hide internal functions from the doc?
> Have I overlook something?
>
> Sincerely Eryk.
>
>
>
> Dipl. bio-chem. Eryk Witold Wolski @ MPI-Moleculare Genetic
> Ihnestrasse 63-73 14195 Berlin 'v'
> tel: 0049-30-83875219 / \
> mail: wolski@molgen.mpg.de ---W-W---- http://www.molgen.mpg.de/~wolski
>
> ______________________________________________
> R-help@stat.math.ethz.ch mailing list
> https://www.stat.math.ethz.ch/mailman/listinfo/r-help
> PLEASE do read the posting guide! http://www.R-project.org/posting-guide.html
>

______________________________________________
R-help@stat.math.ethz.ch mailing list
https://www.stat.math.ethz.ch/mailman/listinfo/r-help
PLEASE do read the posting guide! http://www.R-project.org/posting-guide.html


About this list Date view Thread view Subject view Author view Attachment view

This archive was generated by hypermail 2.1.3 : Mon 31 May 2004 - 23:05:12 EST