Package: washr 1.0.1

Colin Walder

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

A toolkit to set up an R data package in a consistent structure. Automates tasks like tidy data export, data dictionary documentation, README and website creation, and citation management.

Authors:Mian Zhong [aut], Margaux Götschmann [aut], Colin Walder [aut, cre], Lars Schöbitz [aut], Global Health Engineering, ETH Zurich [cph]

washr_1.0.1.tar.gz
washr_1.0.1.zip(r-4.7)washr_1.0.1.zip(r-4.6)washr_1.0.1.zip(r-4.5)
washr_1.0.1.tgz(r-4.6-any)washr_1.0.1.tgz(r-4.5-any)
washr_1.0.1.tar.gz(r-4.7-any)washr_1.0.1.tar.gz(r-4.6-any)
washr_1.0.1.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
card.svg |card.png
washr/json (API)
NEWS

# Install 'washr' in R:

install.packages('washr', repos = c('https://openwashdata.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/openwashdata/washr/issues

Pkgdown/docs site:https://openwashdata.github.io

On CRAN:

4.82 score 3 stars 11 scripts 545 downloads 17 exports 136 dependencies

Last updated from:7380c12ab4. Checks:9 OK. Indexed: yes.

Target	Result	Time
linux-devel-x86_64	OK	164
source / vignettes	OK	217
linux-release-x86_64	OK	198
macos-release-arm64	OK	137
macos-oldrel-arm64	OK	148
windows-devel	OK	87
windows-release	OK	88
windows-oldrel	OK	101
wasm-release	OK	143

Exports:add_creator add_metadata fill_dictionary generate_jsonld generate_roxygen_docs setup_dictionary setup_rawdata setup_readme setup_roxygen setup_website update_access update_attributes update_biblio update_citation update_description update_gsheet_metadata update_metadata

Dependencies:askpass base64enc bit bit64 brew brio bslib cachem callr cellranger cffr cli clipr commonmark cpp11 crayon credentials curl dataspice desc devtools diffobj digest downlit dplyr ellipsis EML emld evaluate fansi farver fastmap fontawesome fs gargle generics gert ggplot2 gh gitcreds glue googledrive googlesheets4 gtable highr hms htmltools htmlwidgets httpuv httr httr2 ids ini isoband jqr jquerylib jsonld jsonlite jsonvalidate knitr labeling later lazyeval lifecycle lubridate magrittr memoise mime miniUI openssl otel pak pillar pkgbuild pkgconfig pkgdown pkgload praise prettyunits processx profvis progress promises ps purrr R6 ragg rappdirs rcmdcheck RColorBrewer Rcpp readr rematch rematch2 rhandsontable rlang rmarkdown roxygen2 rprojroot rstudioapi rversions S7 sass scales sessioninfo shiny sourcetools stringi stringr sys systemfonts testthat textshaping tibble tidyr tidyselect timechange tinytex tzdb urlchecker usethis utf8 uuid V8 vctrs viridisLite vroom waldo whisker withr xfun xml2 xopen xtable yaml zip

Get started with washr

Rendered fromwashr.Rmdusingknitr::rmarkdownon May 26 2026.

Last update: 2024-11-01
Started: 2024-09-20

Citation

Development and contributors

Readme and manuals

Help Manual

Help page	Topics
Add contributors to the creators metadata file	add_creator
Adds metadata files and creates the metadata folder	add_metadata
Fill in the dictionary file based on the tidy data information	fill_dictionary
Function to create a JSON-LD document from available metadata	generate_jsonld
Generate roxygen2 documentation from a CSV file	generate_roxygen_docs
Create a dictionary file for tidy data sets	setup_dictionary
Create the data-raw directory with a data-processing.R template	setup_rawdata
Generate the README RMarkdown file	setup_readme
Set up roxygen documentation for all tidy data sets using the dictionary	setup_roxygen
Set up a pkgdown website for the data package	setup_website
Updates the access metadata file with links to the downloadable data files	update_access
Update metadata attributes file	update_attributes
Function to update the biblio metadata file	update_biblio
Update the citation file for the dataset.	update_citation
Update the DESCRIPTION file to conform with openwashdata standards	update_description
Updates metadata google sheet automatically	update_gsheet_metadata
Updates all metadata files simultaneously	update_metadata