generateDocs: generate documentation for a folder of source files

Description Usage Arguments Value Examples

View source: R/manage.R

Description

generate documentation for a folder of source files

Usage

1
generateDocs(folder = ".", pattern = "*.R$", fields)

Arguments

folder

path to the folder with files to be documented

pattern

file name filter

fields

attributes/metadata that should be searched for as a named vector such as c(Title = "Title of the file") where Title is the pattern and Title of the file is used as header

Value

a character vector of a markdown table with header based on fields values

Examples

1
2
3
4
# chunk of a Rmarkdown doc
fields <- c(Title = "Data source", DO = "What the code does", Author = "Author")
tab <- generateDocs(fields = fields)
paste(tab, collapse = "")

vh-d/VHtools documentation built on May 3, 2019, 6:11 p.m.