Wolski
2004-May-25 08:01 UTC
[R] Hiding internal package functions for the doc. pkg-internal.Rd
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 at molgen.mpg.de ---W-W---- http://www.molgen.mpg.de/~wolski
Henrik Bengtsson
2004-May-25 09:48 UTC
[R] Hiding internal package functions for the doc. pkg-internal.Rd
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 at molgen.mpg.de ---W-W---- http://www.molgen.mpg.de/~wolski > > ______________________________________________ > R-help at 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 >
Seemingly Similar Threads
- Is there a way to represent the ... argument in signature?
- 2 images with 2 color scales on one graphic device. How to get it?
- ./configure --prefix and R_LIBS
- pkg-manual.dvi. How to generate the start page?
- plot.dendrogram and plot.hclust ZOOM into the height?