parse_and_save

Parse the input Rd file and save the roxygen documentation into a file

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

parse_and_save function

<dl><dt>path</dt>
<dd>the path of the Rd file</dd>
<dt>file</dt>
<dd>the path to save the roxygen documentation</dd>
<dt>usage</dt>
<dd>logical: whether to include the usage section in the output</dd></dl>

Arguments

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

Author

Parse the input Rd file and save the roxygen documentation into a file — parse_and_save

<dl>

<dt>path</dt>
<dd>the path of the Rd file</dd>


<dt>file</dt>
<dd>the path to save the roxygen documentation</dd>


<dt>usage</dt>
<dd>logical: whether to include the usage section in the output</dd>

</dl>

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

parse_and_save: Parse the input Rd file and save the roxygen documentation into a file

Description

Usage

Value

Arguments

Author