The main output file for each element of ... contains links to each
help topic found in the file. This function is designed to render documentation
for functions documented with roxygen2.
Note that the code in provided files will be executed. This function is not
intended to be used on entire programs used for analysis or data assembly. To
only render documentation for a highlighted selection, see the
selected argument.
render_roxygen(
...,
outdir = tempdir(),
selected = FALSE,
open = rstudioapi::isAvailable()
)file paths to R files documented with roxygen2. Defaults to the path of the source editor context.
existing directory to output files to
logical indicating whether to include selected content
from the RStudio Source Editor. When TRUE, the path to the source
editor context is not automatically rendered in full.
logical indicating whether to open the output files
a named logical vector. The names represent the output files
while the value indicates whether the output file was successfully
rendered.