parse_rd: parse documentation files for content

In lagelab/Genoppi: genoppi

parse documentation files for content

Description

A function that parsed markdown documentation files that has been written in devtools::document.

Usage

parse_rd(
  content,
  what = c("description", "title", "format", "references"),
  raw = F,
  combine = T,
  combine.with = "\n"
)

Arguments

content	a vector of strings.
what	a vector of search terms.
raw	boolean. Should the raw data be returned?
combine	boolean. Should the vectors in the list be combined?
combine.with	string. What should the vectors be collapsed with.

Examples

## Not run: 
content = readLines('man/gtex_table.Rd')
parse_rd(content)

## End(Not run)

lagelab/Genoppi documentation built on Oct. 13, 2022, 2:36 p.m.