Learn R Programming

packagedocs (version 0.4.0)

rd_template: Generate the text to put in a rd.rmd file to build a package function reference

Description

Generate the text to put in a rd.rmd file to build a package function reference

Usage

rd_template(code_path, rd_index = "rd_index.yaml", exclude = NULL)

Arguments

code_path

path to the source code directory of the package

rd_index

path to yaml file with index layout information

exclude

vector of Rd entry names to exclude from the resulting document