Publication Toolkit for Water, Sanitation and Hygiene (WASH) Data
Overview
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.
The first minor release under the new maintainer. Every function now reads
what is there, merges its changes, and is safe to run again. The FAIR layer
is one experimental function that derives schema.org metadata from the
package files. Ten exports remain: seven of the nine from 1.0.2
(fill_dictionary() and generate_roxygen_docs() are internal now) plus
three new ones; eight helpers that never reached CRAN are gone. Imports go
from 16 to 10.
New
- New
setup_ci()writes the GitHub Actions workflow that runsR CMD checkon every push and pull request tomainanddev, on macOS, Windows and three versions of R on Linux, and adds the matching badge toREADME.Rmd. The README template carries the badge as well. The openwashdata review standard requires the workflow with thedevtrigger, so a package scaffolded with washr meets that part of the review floor by construction (#86).
Show all changes in 1.1.0Hide the rest of the changes in 1.1.0
update_metadata()is rewritten as the one FAIR step (lifecycle: experimental). It derives a schema.org Dataset description from DESCRIPTION,data-raw/dictionary.csv,CITATION.cffand the files ininst/extdata, writes it as JSON-LD intopkgdown/templates/in-header.htmlso every page of the site carries it, and ends by listing the fields it could not fill. Spatial and temporal coverage and keywords live in DESCRIPTION asX-schema.org-spatialCoverage,X-schema.org-temporalCoverageandX-schema.org-keywords. It no longer calls the dataspice helpers, creates nodata/metadatafolder, and writes noinst/extdata/metadata.json; existing copies of both are ignored.generate_jsonld()is no longer exported (it is the internal builder), and lubridate leaves Imports (#68, #70, #67).- New
use_brand()installs the openwashdata brand (_brand.ymland the logo files it references) from the central openwashdata/brand repository into the active package, refreshes an existing copy idempotently, and wires an existing_pkgdown.ymlto the brand through bslib so the package site renders with the brand fonts and colors (#109). setup_readme()gainshas_example, the argument the guide documents. Withhas_example = TRUEthe README carries an Example section with a commented ggplot2 scaffold for a first plot, pairing with the argument of the same name onsetup_website(). The function now stops with a clear message whendata/holds no data object instead of writing a README withNAin it, and says which data object the template documents when there are several (#74, supersedes #24).update_citation()gainsbuild. Withbuild = FALSEit regenerates the citation files and adds the badge without rebuilding README.md and the site, for scripts and tests (#75).
Changed
- Idempotency and ergonomics sweep of the core (#73). Every function that rewrites a file follows read-merge-write and is safe to re-run:
setup_website()keeps an existing_pkgdown.ymlas it is and only rebuilds the site, so the guide's "answer No when prompted" step goes away; it no longer crashes without a.gitignore; and it leavesdocsignored when a pkgdown workflow deploys the site, or when the newtrack_docs = FALSEargument says so (#104). The example article is created once.- The
_pkgdown.ymltemplate carries the Pages URL as the site URL, the explanatory comments, and a reference index with one entry per data object, matching the openwashdata review standard's template. update_citation()re-run without adoikeeps the DOI already on file instead of dropping it, moves keywords typed intoCITATION.cffby hand toX-schema.org-keywordsin DESCRIPTION (their canonical home, from where cffr carries them forward), and rebuilds the README only when the badge changes.setup_roxygen()re-run regenerates only the@formatblock and keeps everything below it (@source,@examples, and other text), writes nothing when the result is unchanged, and errors clearly when a file has no@formatline instead of crashing.setup_dictionary()records the first class of multi-class columns (POSIXct,ordered,Date) instead of a deparsed vector.- Loading a
.rdafile with several objects, or a file that is not an.rda, now errors with the file name and the reason instead of documenting the first object or crashing.
Fixed
setup_readme()no longer writes a dead license link. The README template carried the package name placeholder in URL encoded form, so whisker never substituted it and every generated README linked to.../%7B%7B%7Bpackagename%7D%7D%7D/blob/main/LICENSE.md(#101).update_citation()addsCITATION.cffto.Rbuildignore, soR CMD checkno longer reports a non-standard file at the top level of the data package. cffr only adds the entry itself when handed a file path, and washr hands it a cff object (#102).
Removed
update_gsheet_metadata()is removed. It appended a row to a private openwashdata Google Sheet, needed interactive Google authentication, and never shipped on CRAN. googlesheets4 leaves Imports with it. The catalogue update becomes org-internal tooling outside the package (#69).- The dataspice helpers are removed:
add_metadata(),add_creator(),update_access(),update_attributes()andupdate_biblio(). None of them shipped on CRAN.update_metadata()replaced their output, and a package that still carriesdata/metadata/keeps it; washr ignores the folder.fill_dictionary()andgenerate_roxygen_docs()are no longer exported;setup_dictionary()andsetup_roxygen()call them. The export surface is now nine functions. dataspice, dplyr, readr, stringr and tibble leave Imports with the removed code (#71, #100, #72).
Dependencies
- devtools moves from Imports to Suggests.
update_citation()still rebuilds README.md throughdevtools::build_readme(), because the README loads the data package, and asks to install devtools when it is missing; the site rebuild callspkgdown::build_site()directly.setup_website()no longer renders the example article on its own, since the site build renders it. The version constraint on utils is dropped; utils is a base package and the constraint silently required R 4.3.3. With the seven packages removed by the FAIR layer work, Imports go from 16 to 10 (#72).
Documentation and tests
- Test bar (#75). Every export has a behavioral test that asserts on file content or output; every
expect_error()names its message; thesetup_rawdata()tests check the rendered template. A test coverage workflow measures coverage on every push and pull request and writes it to the job summary. - Documentation (#76). The Get started vignette walks through the workflow in the order of the publishing guide, one function per step; the README gives the toolkit overview with the stable core and the experimental FAIR layer, and carries the CRAN status badge; every export names its neighbours in the workflow under See also; the reference index is grouped by workflow stage; and the pkgdown site URL points at the openwashdata organisation (it pointed at the dev fork, which broke canonical links).
From NEWS.md in the release
Install
Health
- OK13 OK2026-08-04
- NOTE12 OK, 1 NOTE2026-08-01
- OK13 OK2026-06-09
- ERROR12 OK, 1 ERROR2026-06-08
- OK14 OK2026-03-10
Documentation
- Help pages
- 13 (3 internal)includes a package overview page
- Examples that run
- 0%12 never run
- Exported functions with examples
- 100%
- Documented parameters
- 100%
- Return-value docs
- 100%
- Help pages citing references
- 0%
Downloads
Repository
- PRs merged (all time)
- 85%
- Median days to close, 50 most recently updated closed issues
- 38
- Median days to close, 50 most recently updated closed PRs
- 0
Stars over time
Forks over time
Issues over time
PRs over time
Commits over time
Commit identities over time
9 development-tooling and community-health practices detected across 5 families in the upstream repository
Checks run against github.com/openwashdata/washr on 2026-10-11.
The R CMD check workflow runs on Linux, macOS and Windows, and on R-devel
GitHub Pages site last deployed 2026-09-17 · The repository has a site deploy workflow
pkgdown site last built 2026-09-17
Show all practicesHide 1 practice
This repository shows signs of AI coding tools.
- Claude Codefirst seen on or before 2026-07-23Commits: 3 by its own account · at least 16 crediting it in the message
- Claude CodePull requests: 2 from outside contributors, first on 2026-07-26
- Claude Fable 512 commits · Jul to Aug 2026
- Claude Fable 5.13 commits · Sep 2026
- Claude Opus 51 commit · Sep 2026
Dependencies
Code & Tests
People & History
Previously maintained by Colin Walder (1.0.1).
Package metadata
- First published
- 2024-11-07
- Total releases
- 3 / 2 yrs
- License
- GPL (>= 3) OSI
- Download size
- 50 KB
Cite
Cite this package
Run in R for the authors' preferred citation:
citation("washr")This package has no citation file, so citation() returns this entry built from DESCRIPTION.
Cite the R Observatory
For a number measured here: a download total, a coverage figure, an archival date.
From data release v2026-10-18, which the citation names so these numbers can be found later. More on citing and the projects behind them.