object

These objects are usually created by the parsers, but it is also
useful to generate them by hand for testing.

internal

Generate your Rd documentation, 'NAMESPACE' file, and
collation field using specially formatted comments. Writing
documentation in-line with code makes it easier to keep your
documentation up-to-date as your requirements change. 'roxygen2' is
inspired by the 'Doxygen' system for C++.

Hadley Wickham

roxygen2

In-Line Documentation for R

Peter Danenberg

Gábor Csárdi

Manuel Eugster

Posit Software, PBC 

object function

<dl><dt>value</dt>
<dd>The object itself.</dd>
<dt>alias</dt>
<dd>Alias for object being documented, in case you create a
generator function with different name.</dd></dl>

Arguments

Constructors for S3 object to represent R objects. — object

<dl>

<dt>value</dt>
<dd>The object itself.</dd>


<dt>alias</dt>
<dd>Alias for object being documented, in case you create a
generator function with different name.</dd>

</dl>

object: Constructors for S3 object to represent R objects.

Description

Usage

Arguments