document

This function is a wrapper for the <code><a href="https://roxygen2.r-lib.org/reference/roxygenize.html">roxygen2::roxygenize()</a></code>
function from the roxygen2 package. See the documentation and vignettes of
that package to learn how to use roxygen.

Jennifer Bryan

devtools

Tools to Make Developing R Packages Easier

Hadley Wickham

Jim Hester

Winston Chang

RStudio 

document function

<dl><dt>pkg</dt>
<dd>The package to use, can be a file path to the package or a
package object. See <code>as.package()</code> for more information.</dd>
<dt>roclets</dt>
<dd>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>.</dd>
<dt>quiet</dt>
<dd>if <code>TRUE</code> suppresses output from this function.</dd></dl>

Arguments

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

Use roxygen to document a package. — document

<dl>

<dt>pkg</dt>
<dd>The package to use, can be a file path to the package or a
package object. See <code>as.package()</code> for more information.</dd>


<dt>roclets</dt>
<dd>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>.</dd>


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

</dl>

document: Use roxygen to document a package.

Description

Usage

Arguments

See Also