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.tar.gz(r-4.5-noble)washr_1.0.1.tar.gz(r-4.4-noble)
washr_1.0.1.tgz(r-4.4-emscripten)
washr.pdf |washr.html✨
washr/json (API)
NEWS

# Install 'washr' in R:

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

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

2.70 score 5 scripts 9 exports 97 dependencies

Last updated 10 days agofrom:3002d4ff7c. Checks:OK: 2. Indexed: no.

Target	Result	Date
Doc / Vignettes	OK	Nov 08 2024
R-4.5-linux	OK	Nov 08 2024

Exports:fill_dictionary generate_roxygen_docs setup_dictionary setup_rawdata setup_readme setup_roxygen setup_website update_citation update_description

Dependencies:askpass base64enc brew brio bslib cachem callr cffr cli clipr commonmark cpp11 crayon credentials curl desc devtools diffobj digest downlit ellipsis evaluate fansi fastmap fontawesome fs gert gh gitcreds glue highr htmltools htmlwidgets httpuv httr2 ini jquerylib jsonlite jsonvalidate knitr later lifecycle magrittr memoise mime miniUI openssl pillar pkgbuild pkgconfig pkgdown pkgload praise prettyunits processx profvis promises ps purrr R6 ragg rappdirs rcmdcheck Rcpp remotes rlang rmarkdown roxygen2 rprojroot rstudioapi rversions sass sessioninfo shiny sourcetools stringi stringr sys systemfonts testthat textshaping tibble tinytex urlchecker usethis utf8 V8 vctrs waldo whisker withr xfun xml2 xopen xtable yaml zip

Get started with washr

Rendered fromwashr.Rmdusingknitr::rmarkdownon Nov 08 2024.

Last update: 2024-11-07
Started: 2024-11-07

Citation

Readme and manuals

Help Manual

Help page	Topics
Fill in the dictionary file based on the tidy data information	fill_dictionary
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
Update the citation file for the dataset.	update_citation
Update the DESCRIPTION file to conform with openwashdata standards	update_description