rd_section

An <code>rd_section</code> represents an Rd command that can appear at the top-level
of an Rd document, like <code>\name{}</code>, <code>\title{}</code>, <code>\description{}</code>, or
<code>\section{}</code>.

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 

rd_section function

<dl><dt>type</dt>
<dd>Section type. Stored in <code>type</code> field, and in class
<code>rd_section_{type}</code>. To avoid namespace clashes between different
extensions, this should include the package name.</dd>
<dt>value</dt>
<dd>Section data. Only used by <code><a href="/link/format()?package=roxygen2&version=7.3.1" data-mini-rdoc="roxygen2::format()">format()</a></code> and <code><a href="/link/merge()?package=roxygen2&version=7.3.1" data-mini-rdoc="roxygen2::merge()">merge()</a></code> methods.</dd></dl>

Arguments

If provide your own <code>rd_section</code> type, you'll also need to define a
<code>format.rd_section_{type}</code> method that returns formatted Rd output. You
may also need to provide a <code>merge.rd_section_{type}</code> method if two
sections can not be combined with <code>rd_section(x$type, c(x$value, y$value))</code>.
See <code>vignette("extending")</code> for more details.

Methods

Construct an rd_section object — rd_section

<dl>

<dt>type</dt>
<dd>Section type. Stored in <code>type</code> field, and in class
<code>rd_section_{type}</code>. To avoid namespace clashes between different
extensions, this should include the package name.</dd>


<dt>value</dt>
<dd>Section data. Only used by <code><a href='https://rdrr.io/r/base/format.html'>format()</a></code> and <code><a href='https://rdrr.io/r/base/merge.html'>merge()</a></code> methods.</dd>

</dl>

If provide your own <code>rd_section</code> type, you'll also need to define a
<code>format.rd_section_{type}</code> method that returns formatted Rd output. You
may also need to provide a <code>merge.rd_section_{type}</code> method if two
sections can not be combined with <code>rd_section(x$type, c(x$value, y$value))</code>.
See <code>vignette("extending")</code> for more details.

rd_section: Construct an `rd_section` object

Description

Usage

Arguments

Methods