readRdHelp.default

readRdHelp

Reads one or more Rd help files in a certain format.

programming

Utility functions useful when programming and developing R packages.

Henrik Bengtsson

R.utils

Various Programming Utilities

readRdHelp function

<dl> <dt>...</dt>
<dd>Arguments passed to <code><a href="/link/help?package=R.utils&version=2.12.3" data-mini-rdoc="R.utils::help">help</a></code>.</dd> <dt>format</dt>
<dd>A <code><a href="/link/character?package=R.utils&version=2.12.3" data-mini-rdoc="R.utils::character">character</a></code> string specifying the return type.</dd> <dt>drop</dt>
<dd>If <code><a href="/link/FALSE?package=R.utils&version=2.12.3" data-mini-rdoc="R.utils::FALSE">FALSE</a></code> or more than one help entry is found, the result
 is returned as a <code><a href="/link/list?package=R.utils&version=2.12.3" data-mini-rdoc="R.utils::list">list</a></code>.</dd></dl>

Arguments

Author

Reads one or more Rd help files in a certain format — readRdHelp

<dl>

 <dt>...</dt>
<dd>Arguments passed to <code><a href='https://rdrr.io/r/utils/help.html'>help</a></code>.</dd>

 <dt>format</dt>
<dd>A <code><a href='https://rdrr.io/r/base/character.html'>character</a></code> string specifying the return type.</dd>

 <dt>drop</dt>
<dd>If <code><a href='https://rdrr.io/r/base/logical.html'>FALSE</a></code> or more than one help entry is found, the result
 is returned as a <code><a href='https://rdrr.io/r/base/list.html'>list</a></code>.</dd>

</dl>

readRdHelp: Reads one or more Rd help files in a certain format

Description

Usage

Value

Arguments

Author