create_roxygen

The parsed information is converted to a vector of roxygen tags.

Functions to convert Rd to 'roxygen' documentation. It can parse an
Rd file to a list, create the 'roxygen' documentation and update the original
R script (e.g. the one containing the definition of the function)
accordingly. This package also provides utilities that can help developers
build packages using 'roxygen' more easily. The 'formatR' package can be used
to reformat the R code in the examples sections so that the code will be
more readable.

Yihui Xie

Rd2roxygen

Convert Rd to 'Roxygen' Documentation

Hadley Wickham

create_roxygen function

<dl><dt>info</dt>
<dd>the named list of the parsed documentation</dd>
<dt>usage</dt>
<dd>logical: whether to include the usage section in the output
(this can be useful when there are multiple functions in a single usage
section, but generally it is not necessary because roxygen can generate the
usage section automatically)</dd></dl>

Arguments

Hadley Wickham; modified by Yihui Xie &lt;<a href="http://yihui.org">http://yihui.org</a>&gt;

Author

Create the roxygen documentation — create_roxygen

<dl>

<dt>info</dt>
<dd>the named list of the parsed documentation</dd>


<dt>usage</dt>
<dd>logical: whether to include the usage section in the output
(this can be useful when there are multiple functions in a single usage
section, but generally it is not necessary because roxygen can generate the
usage section automatically)</dd>

</dl>

Hadley Wickham; modified by Yihui Xie &lt;<a href='http://yihui.org'>http://yihui.org</a>&gt;

create_roxygen: Create the roxygen documentation

Description

Usage

Value

Arguments

Author

Examples