document

The function <code>rextendr::document()</code> updates the package documentation for an
R package that uses <code>extendr</code> code, taking into account any changes that were
made in the Rust code. It is a wrapper for <code><a href="https://devtools.r-lib.org/reference/document.html">devtools::document()</a></code>, and it
executes <code>extendr</code>-specific routines before calling <code><a href="https://devtools.r-lib.org/reference/document.html">devtools::document()</a></code>.
Specifically, it ensures that Rust code is recompiled (when necessary) and that
up-to-date R wrappers are generated before regenerating the package documentation.

Provides functions to compile and load Rust code from R, similar
to how 'Rcpp' or 'cpp11' allow easy interfacing with C++ code. Also provides
helper functions to create R packages that use Rust code. Under the hood,
the Rust crate 'extendr' is used to do all the heavy lifting.

Ilia Kosenkov

rextendr

Call Rust Code from R using the 'extendr' Crate

Claus O. Wilke

Andy Thomason

Mossa M. Reimert

Malcolm Barrett

Josiah Parry

Kenneth Vernon

Alberson Miranda

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><a href="https://devtools.r-lib.org/reference/as.package.html">as.package()</a></code> for more information.</dd>
<dt>quiet</dt>
<dd>if <code>TRUE</code> suppresses output from this function.</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></dl>

Arguments

The function <code>rextendr::document()</code> updates the package documentation for an
R package that uses <code>extendr</code> code, taking into account any changes that were
made in the Rust code. It is a wrapper for <code><a href='https://devtools.r-lib.org/reference/document.html'>devtools::document()</a></code>, and it
executes <code>extendr</code>-specific routines before calling <code><a href='https://devtools.r-lib.org/reference/document.html'>devtools::document()</a></code>.
Specifically, it ensures that Rust code is recompiled (when necessary) and that
up-to-date R wrappers are generated before regenerating the package documentation.

Compile Rust code and generate package documentation. — document

<dl>

<dt>pkg</dt>
<dd>The package to use, can be a file path to the package or a
package object. See <code><a href='https://devtools.r-lib.org/reference/as.package.html'>as.package()</a></code> for more information.</dd>


<dt>quiet</dt>
<dd>if <code>TRUE</code> suppresses output from this function.</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>

</dl>

document: Compile Rust code and generate package documentation.

Description

Usage

Value

Arguments