document

The package to use, can be a file path to the package or a
package object. See <code><a rd-options="=as.package" href="/link/as.package()?package=devtools&version=2.4.2&to=%3Das.package" data-mini-rdoc="=as.package::as.package()">as.package()</a></code> for more information.

Character vector of roclet names to use with package.
The default, <code>NULL</code>, uses the roxygen <code>roclets</code> option,
which defaults to <code>c("collate", "namespace", "rd")</code>.

roclets

if <code>TRUE</code> suppresses output from this function.

quiet

This function is a wrapper for the <code><a rd-options="roxygen2:roxygenize" href="/link/roxygen2%3A%3Aroxygenize()?package=devtools&version=2.4.2&to=roxygen2%3Aroxygenize" data-mini-rdoc="roxygen2:roxygenize::roxygen2::roxygenize()">roxygen2::roxygenize()</a></code>
function from the roxygen2 package. See the documentation and vignettes of
that package to learn how to use roxygen.

Jim Hester

devtools

Tools to Make Developing R Packages Easier

Hadley Wickham

Winston Chang

RStudio 

document function

The package to use, can be a file path to the package or a
package object. See <code><a rd-options='=as.package' href='as.package()'>as.package()</a></code> for more information.

This function is a wrapper for the <code><a rd-options='roxygen2:roxygenize' href='roxygen2::roxygenize()'>roxygen2::roxygenize()</a></code>
function from the roxygen2 package. See the documentation and vignettes of
that package to learn how to use roxygen.

document: Use roxygen to document a package.

Description

Usage

Arguments

See Also