[Rd] "Proper" way to use a "hidden" function in an R-package?
edd at debian.org
Sat Jul 13 17:40:21 CEST 2013
On 12 July 2013 at 11:42, Gabriel Becker wrote:
| All exported functions must have documentation entries to pass R CMD check
| without warnings.
| Functions within your package do not need another function in your package
| to be exported to call it without :::, but code not in your package (ie
| functions in other packages or user code) do.
| If you have reason to believe that a user or function from another package
| will directly call a function, it should be exported, and thus documented.
| If not, you can use them within code in your own package without exporting
| them, using :::, or documenting them.
All true, but what Jonathan _really_ wanted to know is that adding a single
in an .Rd file will also satisfy R CMD check. Some package use a file
undocumented.Rd to regreoup these; I sometimes use the Packagename-package.Rd
Dirk Eddelbuettel | edd at debian.org | http://dirk.eddelbuettel.com
More information about the R-devel