roxygen2: rd_section – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

rd_section

Construct an rd_section object

Description

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

Usage

rd_section(type, value)

Arguments

`type`	Section type. Stored in `type` field, and in class `rd_section_{type}`. To avoid namespace clashes between different extensions, this should include the package name.
`value`	Section data. Only used by `format()` and `merge()` methods.

Methods

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

roxygen2

In-Line Documentation for R

v7.1.1

GPL (>= 2)

Authors

Hadley Wickham [aut, cre, cph] (<https://orcid.org/0000-0003-4757-117X>), Peter Danenberg [aut, cph], Gábor Csárdi [aut], Manuel Eugster [aut, cph], RStudio [cph]

Initial release