Skip to contents

Set up the data package

Scaffold the raw data folder and the processing script

setup_ci()
Set up the R CMD check workflow for the data package
setup_rawdata()
Create the data-raw directory with a data-processing.R template

Document the data

The dictionary and the roxygen documentation it feeds

setup_dictionary()
Create a dictionary file for tidy data sets
setup_roxygen()
Set up roxygen documentation for all tidy data sets using the dictionary

Describe the package

DESCRIPTION as the canonical source, and the schema.org metadata derived from it (experimental)

update_description()
Update the DESCRIPTION file to conform with openwashdata standards
update_metadata() experimental
Generate and embed the schema.org metadata of the data package

Publish

README, website, brand, and the citation with its DOI

setup_readme()
Generate the README RMarkdown file
setup_website()
Set up a pkgdown website for the data package
use_brand()
Install or refresh the openwashdata brand in the active package
update_citation()
Update the citation file for the dataset.