[R-pkg-devel] Documentation for non-user-level objects

[Bert Gunter]

1. Don't export them.

2. Use:  \keyword{ internal } in the .Rd file
>From "Writing R Extensions"
"The special keyword ‘internal’ marks a page of internal objects that
are not part of the package’s 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, including the alphabetical list
of objects in the HTMLhelp system."

Cheers,
Bert

Bert Gunter

"The trouble with having an open mind is that people keep coming along
and sticking things into it."
-- Opus (aka Berkeley Breathed in his "Bloom County" comic strip )

On Sun, May 10, 2020 at 2:31 PM Sapphire Zhou
<sapphirezhou0404 using gmail.com> 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.
>
> Thanks!
> ______________________________________________
> R-package-devel using r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-package-devel