roxygenize

roxygenise

This is the workhorse function that uses roclets, the built-in document
transformation functions, to build all documentation for a package. See
the documentation for the individual roclets, <code>rd_roclet()</code>,
<code>namespace_roclet()</code>, and for <code>update_collate()</code>,
for more details.

Generate your Rd documentation, 'NAMESPACE' file, and
collation field using specially formatted comments. Writing
documentation in-line with code makes it easier to keep your
documentation up-to-date as your requirements change. 'roxygen2' is
inspired by the 'Doxygen' system for C++.

Hadley Wickham

roxygen2

In-Line Documentation for R

Peter Danenberg

Gábor Csárdi

Manuel Eugster

Posit Software, PBC 

roxygenize function

<dl><dt>package.dir</dt>
<dd>Location of package top level directory. Default is
working directory.</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>load_code</dt>
<dd>A function used to load all the R code in the package
directory. The default, <code>NULL</code>, uses the strategy defined by
the <code>load</code> roxygen option, which defaults to <code>load_pkgload()</code>.
See <a href="/link/load?package=roxygen2&version=7.3.2" data-mini-rdoc="roxygen2::load">load</a> for more details.</dd>
<dt>clean</dt>
<dd>If <code>TRUE</code>, roxygen will delete all files previously
created by roxygen before running each roclet.</dd></dl>

Arguments

Process a package with the Rd, namespace and collate roclets — roxygenize

<dl>

<dt>package.dir</dt>
<dd>Location of package top level directory. Default is
working directory.</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>load_code</dt>
<dd>A function used to load all the R code in the package
directory. The default, <code>NULL</code>, uses the strategy defined by
the <code>load</code> roxygen option, which defaults to <code>load_pkgload()</code>.
See <a href='https://rdrr.io/r/base/load.html'>load</a> for more details.</dd>


<dt>clean</dt>
<dd>If <code>TRUE</code>, roxygen will delete all files previously
created by roxygen before running each roclet.</dd>

</dl>

roxygenize: Process a package with the Rd, namespace and collate roclets

Description

Usage

Value

Arguments

Details