document: Compile Rust code and generate package documentation.

In rextendr: Call Rust Code from R using the 'extendr' Crate

Compile Rust code and generate package documentation.

Description

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

Usage

document(pkg = ".", quiet = FALSE, roclets = NULL)

Arguments

pkg	The package to use, can be a file path to the package or a package object. See as.package() for more information.
quiet	if TRUE suppresses output from this function.
roclets	Character vector of roclet names to use with package. The default, NULL, uses the roxygen roclets option, which defaults to c("collate", "namespace", "rd").

Value

No return value, called for side effects.

rextendr documentation built on July 9, 2023, 5:54 p.m.