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.

The template documents the first data object in ⁠data/⁠ (alphabetically); add a section per further object by hand. It stops when ⁠data/⁠ holds no data object, because every data section needs one.

Usage

setup_readme(force = FALSE, has_example = FALSE)

Arguments

force	Logical. If FALSE (the default), the function stops when a README.Rmd already exists. Set to TRUE to overwrite the existing file.
has_example	Logical. Should the README include an Example section with a commented ggplot2 scaffold for a first plot of the data? Defaults to FALSE. Pairs with the has_example argument of setup_website(), which adds the matching article to the site.

Value

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

See Also

Before: update_description(). Next: setup_website(), which builds the site from README.md.

Other publishing functions: setup_website(), use_brand()

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()
# With an Example section to fill with a first plot
setup_readme(has_example = TRUE)

## End(Not run)

washr documentation built on Sept. 2, 2026, 5:07 p.m.