Skip to contents

Using washr

Setting up your data repository

setup_rawdata()
Create the data-raw directory with a data-processing.R template

Documenting your data

Helper functions to document both your dataset(s) and functions

setup_dictionary()
Create a dictionary file for tidy data sets
fill_dictionary()
Fill in the dictionary file based on the tidy data information
setup_roxygen()
Set up roxygen documentation for all tidy data sets using the dictionary
generate_roxygen_docs()
Generate roxygen2 documentation from a CSV file

Adding metadata

Helper functions to add metadata

add_citation()
Generate a citation file for the dataset.
update_description()
Update the DESCRIPTION file to conform with openwashdata standards

Publishing your data

Helper functions to communicate your data

setup_readme()
Generate the README Rmarkdown file
setup_website()
Set up a pkgdown website for the data package