As well as documenting every object inside the package, you can also
document the package itself by documenting the special sentinel
"_PACKAGE". This automatically includes information parsed
from the DESCRIPTION, including title, description, list of
authors, and useful URLs.
We recommend placing package documentation in
{pkgname}-package.R, and have
@keywords internal. Use
usethis::use_package_doc() to set up automatically. Here’s
an example:
#' @keywords internal
"_PACKAGE"Package documentation is a good place to put
# Package options that documents options used by the
package.
Some notes:
By default, aliases will be added so that both
?pkgnameandpackage?pkgnamewill find the package help. If there’s an existing function calledpkgname, use@aliases {pkgname}-package NULLto override the default.Use
@referencesto point to published material about the package that users might find helpful.