parse_rd: Parse all Rd files in package

In TalhoukLab/biostatUtil: Utility Functions Used in Biostatistics Projects

Parse all Rd files in package

Description

Parse all Rd files in a package and return metadata as a data frame.

Usage

parse_rd(file = NULL, tags = c("name", "title", "desc", "details"))

Arguments

file	file path to save table
tags	sections to extract from Rd files. Missing entries labelled as NA

Details

The function requires that the working directory is set to the package's root directory.

Value

a table with information on a package's documented objects (functions and data). Rows are objects, and columns are tags.

Author(s)

Derek Chiu

Examples

## Not run: 
tab <- parse_rd()
str(tab)

## End(Not run)

TalhoukLab/biostatUtil documentation built on April 14, 2025, 4:15 a.m.