Rd (version 0.2.0)

Rd_string_creation: Rd String Construction

Description

Construct a Rd string type.

Usage

Rd_string(content, type = c("TEXT", "RCODE", "VERB", "COMMENT",
  "UNKNOWN", "LIST"))
Rd_text(content)
Rd_rcode(content)
Rd_verb(content)
Rd_symb(content)
Rd_comment(content)

Arguments

content

a string to type as an Rd string type

type

the type of text is is.

Functions

• Rd_text: Type as plain text.

• Rd_rcode: Type as R Code.

• Rd_verb: Type as R symbol or 'verb'.

• Rd_symb: Type as R symbol or 'verb'.

• Rd_comment: type as Rd comment. Comments must start with the comment character '

See Also

Other construction: Rd_tag, Rd

Examples

# NOT RUN {
## Plain text
Rd_text("Plain text")
## R Code
Rd_rcode("code()")
## Symbols, i.e. verbs
Rd_verb("verb")
Rd_symb("symbol")
## Rd Comments
Rd_comment("% Rd/LaTeX comment")
# }