Rd (version 0.2.0)

Rd_indent: Indent Rd

Description

Indent Rd

Usage

Rd_indent(rd, indent.with = getOption("Rd::indent.with", "  "),
  recursive = TRUE, ..., no.first = is(rd, "Rd_tag"), .check = TRUE)

Arguments

rd

an Rd container or an Rd tag.

indent.with

What to indent with. See Rd_clean_indent().

recursive

Indent recursively?

...

Ignored but included for forward compatibility and to force full names on subsequent parameters.

no.first

if the first element should be indented.

.check

check for valid Rd?

Examples

# NOT RUN {
(x <- Rd_description("line 1\n", "line 2\n"))
Rd_indent(x)
# }