parse_rd_db: Parse R-Package Dataset Documentation

View source: R/parse_rd_db.R

parse_rd_dbR Documentation

Parse R-Package Dataset Documentation

Description

Reads and parses R documentation (Rd) files.

Usage

parse_rd_db(..., doc_type = "data")

Arguments

...

Arguments to be passed to the tools::Rd_db function, such as package, a character string naming an installed package.

doc_type

'character' vector. Document type, such as data for dataset objects.

Value

A named list containing the documentation sections as character strings.

Author(s)

J.C. Fisher, U.S. Geological Survey, Idaho Water Science Center

Examples

l <- parse_rd_db(package = "inldata")
str(l, 1)

inldata documentation built on Sept. 12, 2024, 9:34 a.m.