The hardware and bandwidth for this mirror is donated by dogado GmbH, the Webhosting and Full Service-Cloud Provider. Check out our Wordpress Tutorial.
If you wish to report a bug, or if you are interested in having us mirror your free-software or open-source project, please feel free to contact us at mirror[@]dogado.de.
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:
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
?pkgname and package?pkgname will find the
package help. If there’s an existing function called
pkgname, use @aliases {pkgname}-package NULL
to override the default.
Use @references to point to published material about
the package that users might find helpful.
These binaries (installable software) and packages are in development.
They may not be fully stable and should be used with caution. We make no claims about them.
Health stats visible at Monitor.