Rd_title: Wrap an object so that it can be used as a section element of...
In gbRd: Utilities for Processing Rd Objects and Files
Rd_title R Documentation
Wrap an object so that it can be used as a section element of an Rd object.
Description
Wrap an object so that it can be used as a section element of an Rd object.
Usage
Rdo_set_sectag(s,sectag,eltag)
Rd_title(s)
Rd_name(s)
Rd_args(s)
Arguments
s
the object to be wrapped, often a string, see Details
sectag
the section tag, a string
eltag
the element tag, a string
Details
Rdo_set_sectag sets atrribute "Rd_tag" of the object s
to eltag, then wraps s in list() with "Rd_tag"
attribute sectag.
The remaining functions provide one-argument access for some
frequently used special cases. eltag is "TEXT" for
Rd_title and "VERB" for Rd_name and Rd_args. The
values of sectag are \title, \name and
\arguments, respectively.
Value
A tagged list as described in Details.
Author(s)
Georgi N. Boshnakov
Examples
Rd_title("My seq")
Rd_name("myseq")
"a" %in% letters
# to do: more examples
gbRd documentation built on June 22, 2024, 11:34 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| Rd_title | R Documentation |
Wrap an object so that it can be used as a section element of an Rd object.
Description
Wrap an object so that it can be used as a section element of an Rd object.
Usage
Rdo_set_sectag(s,sectag,eltag)
Rd_title(s)
Rd_name(s)
Rd_args(s)
Arguments
s |
the object to be wrapped, often a string, see Details |
sectag |
the section tag, a string |
eltag |
the element tag, a string |
Details
Rdo_set_sectag sets atrribute "Rd_tag" of the object s
to eltag, then wraps s in list() with "Rd_tag"
attribute sectag.
The remaining functions provide one-argument access for some
frequently used special cases. eltag is "TEXT" for
Rd_title and "VERB" for Rd_name and Rd_args. The
values of sectag are \title, \name and
\arguments, respectively.
Value
A tagged list as described in Details.
Author(s)
Georgi N. Boshnakov
Examples
Rd_title("My seq")
Rd_name("myseq")
"a" %in% letters
# to do: more examples
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.