Skip to contents

Generate the README Rmarkdown file

Source: R/setup_readme.R
setup_readme.Rd

setup_readme() uses the openwashdata README template to generate README files based on datasets retrieved from the data/ directory. It helps in creating consistent and informative README documentation for your data packages.

Usage

setup_readme()

Value

NULL. This function creates a README.Rmd under the package directory.

Examples

if (FALSE) { # \dontrun{
# Generate the README file after setting up the dictionary
setup_dictionary()
# Complete and save the dictionary CSV file with variable descriptions
setup_readme()
} # }