[R-pkg-devel] Documentation for non-user-level objects
bbo|ker @end|ng |rom gm@||@com
Sun May 10 23:35:40 CEST 2020
If you've exported them then they are "user-level objects". You can
either remove them from the list of exported objects (edit your
NAMESPACE or change your roxygen specifications), or document them
somewhere. One standard solution is to use the "internal" keyword
they still need to be documented, but they're not in the package index.
"Using the internal keyword removes all functions in the associated .Rd
file from the documentation index and disables some of their automated
tests. A common use case is to both export a function (using |@export|)
and marking it as internal. That way, advanced users can access a
function that new users would be confused about if they were to see it
in the index."
Hope that's helpful; if not, feel free to give a little more
detail/clarify your situation.
On 5/10/20 5:26 PM, Sapphire Zhou wrote:
> I met a problem when I uploaded the package to CRAN. There is a warning told me
> “All user-level objects in a package should have documentation entries.”
> Actually, those functions are not user-level functions. How could I claim non-user-level functions in an R package.
> Is there any idea to remove this warning.
> R-package-devel using r-project.org mailing list
[[alternative HTML version deleted]]
More information about the R-package-devel