[R-pkg-devel] How to avoid R CMD check warning for documentation of non-package functions?

Konrad Rudolph konr@d@rudo|ph @end|ng |rom gm@||@com
Thu Dec 3 11:48:23 CET 2020


On Wed, Dec 2, 2020 at 7:44 PM Duncan Murdoch <murdoch.duncan using gmail.com> wrote:
> I haven't tried this, but I believe if you define functions with the
> right name and header in your package but don't export them the warning
> will go away.

Thanks, works like a charm.

> If that doesn't work (or defining those causes other issues), a more
> involved workaround would be to change the \docType{} declaration for
> the help page.  \docType{package} is the most free-form, but you might
> get warned if you have two of them.  \docType{data} might be flexible
> enough.  If you do this, you won't use \usage{} or \arguments{}, you'll
> put together your own sections using \section{Usage}{ ... } and
> \section{Arguments}{ ... } and try to get the formatting right.

I’ll keep this in mind! It might come handy.

-- 
Konrad Rudolph // @klmr



More information about the R-package-devel mailing list