render_package_manual

render_base_manuals

r_universe_link

Renders complete package reference manual in HTML format.

Generates simple and beautiful one-page HTML reference manuals
with package documentation. Math rendering and syntax highlighting are done
server-side in R such that no JavaScript libraries are needed in the
browser, which makes the documentation portable and fast to load.

Jeroen Ooms

postdoc

Minimal and Uncluttered Package Documentation

render_package_manual function

<dl><dt>package</dt>
<dd>name of the package</dd>
<dt>outdir</dt>
<dd>where to put the html file</dd>
<dt>link_cb</dt>
<dd>callback function which can be used to customize hyperlinks to
other packages. This function gets invoked when a help file contains links to
another package, and should return the URL to the html reference manual for
this other package. Set to <code>NULL</code> to drop cross-package links.</dd></dl>

Arguments

Generate HTML reference manual — render_package_manual

<dl>

<dt>package</dt>
<dd>name of the package</dd>


<dt>outdir</dt>
<dd>where to put the html file</dd>


<dt>link_cb</dt>
<dd>callback function which can be used to customize hyperlinks to
other packages. This function gets invoked when a help file contains links to
another package, and should return the URL to the html reference manual for
this other package. Set to <code>NULL</code> to drop cross-package links.</dd>

</dl>

render_package_manual: Generate HTML reference manual

Description

Usage

Value

Arguments

Details

Examples