setup_readme: Generate the README RMarkdown file

In washr: Publication Toolkit for Water, Sanitation and Hygiene (WASH) Data

Generate the README RMarkdown file

Description

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

## Not run: 
# Generate the README file after setting up the dictionary
setup_dictionary()
# Complete and save the dictionary CSV file with variable descriptions
setup_readme()

## End(Not run)

washr documentation built on April 4, 2025, 1:10 a.m.