Use roxygen to document a package.
This function is a wrapper for the roxygen2::roxygenize()
function from the roxygen2 package. See the documentation and vignettes of
that package to learn how to use roxygen.
document(pkg = ".", roclets = NULL, quiet = FALSE)
pkg |
The package to use, can be a file path to the package or a
package object. See |
roclets |
Character vector of roclet names to use with package.
The default, |
quiet |
if |
roxygen2::roxygenize(),
browseVignettes("roxygen2")
Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.