Skip to contents

Set up roxygen documentation for all tidy data sets using the dictionary

Source: R/setup_roxygen.R
setup_roxygen.Rd

setup_roxygen() creates Roxygen documentation for all tidy data sets found in the dictionary file. The dictionary should include columns for directory, file name, variable name, variable type, and description. This function generates Roxygen comments with this information, facilitating consistent and thorough documentation for your data sets.

Usage

setup_roxygen()

Value

NULL. This function creates documentation files inside "R/". Error if tidy data cannot be found.

Examples

if (FALSE) { # \dontrun{
setup_dictionary()
# Go to data-raw/dictionary.csv and complete column description.
setup_roxygen()
} # }