Rd_title {gbRd}

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