Skip to contents

Parse R documentation

Source: R/parseRd.R
parseRd.Rd

Modified version of tools:::.Rd_get_metadata() that keeps whitespace and returns character instead of matrix.

Usage

parseRd(object, tag)

rdTags(object)

Arguments

object

Rd. R documentation, returned from tools::Rd_db().

tag

character(1). Desired metadata type.

These types are supported:

  • title.

  • description.

  • usage.

  • arguments.

  • value.

  • references.

  • seealso.

  • examples.

Functions

  • rdTags(): Modified version of the unexported tools:::RdTags() function.

Note

Updated 2023-09-25.

See also

Examples

## > db <- tools::Rd_db("base")
## > head(names(db))
## > rd <- db[["nrow.Rd"]]
## > print(rdTags(rd))
## > examples <- parseRd(rd, tag = "examples")
## > print(examples)