compileRdoc

Compiles the Rdoc help comments in a package by parsing the source code files and writes Rd help files.

internal

documentation

Methods and classes for object-oriented programming in R with or without references.  Large effort has been made on making definition of methods as simple as possible with a minimum of maintenance for package developers.  The package has been developed since 2001 and is now considered very stable.  This is a cross-platform package implemented in pure R that defines standard S3 classes without any tricks.

Henrik Bengtsson

R.oo

R Object-Oriented Programming with or without References

compileRdoc function

<dl> <dt>pkgname</dt>
<dd>A <code><a href="/link/character?package=R.oo&version=1.26.0" data-mini-rdoc="R.oo::character">character</a></code> string specifying the package name.
 If <code><a href="/link/NULL?package=R.oo&version=1.26.0" data-mini-rdoc="R.oo::NULL">NULL</a></code>, the package name is inferred from the DESCRIPTION file
 that is automatically search for in the subdirectories.</dd> <dt>path</dt>
<dd>A <code><a href="/link/character?package=R.oo&version=1.26.0" data-mini-rdoc="R.oo::character">character</a></code> string specifying the path of the
 package source directory.</dd> <dt>...</dt>
<dd>Additional arguments passed to <code>Rdoc\$compile()</code>.</dd> <dt>verbose</dt>
<dd>If <code><a href="/link/TRUE?package=R.oo&version=1.26.0" data-mini-rdoc="R.oo::TRUE">TRUE</a></code>, verbose output is printed, otherwise not.</dd></dl>

Arguments

Author

Compiles the Rdoc help comments in a package — compileRdoc

<dl>

 <dt>pkgname</dt>
<dd>A <code><a href='https://rdrr.io/r/base/character.html'>character</a></code> string specifying the package name.
 If <code><a href='https://rdrr.io/r/base/NULL.html'>NULL</a></code>, the package name is inferred from the DESCRIPTION file
 that is automatically search for in the subdirectories.</dd>

 <dt>path</dt>
<dd>A <code><a href='https://rdrr.io/r/base/character.html'>character</a></code> string specifying the path of the
 package source directory.</dd>

 <dt>...</dt>
<dd>Additional arguments passed to <code>Rdoc\$compile()</code>.</dd>

 <dt>verbose</dt>
<dd>If <code><a href='https://rdrr.io/r/base/logical.html'>TRUE</a></code>, verbose output is printed, otherwise not.</dd>

</dl>

compileRdoc: Compiles the Rdoc help comments in a package

Description

Usage

Value

Arguments

Author

Details

See Also