Skip to content

Review pass: citation files with the Zenodo DOI, site from gh-pages, CI on dev, version 1.0.2 - #6

Merged
larnsce merged 6 commits into
mainfrom
dev
Sep 24, 2026
Merged

larnsce merged 6 commits into
mainfrom
dev

Conversation

@larnsce

@larnsce larnsce commented Sep 23, 2026

Copy link
Copy Markdown
Contributor

Summary

Mechanical pass from the pkgreview check script and the intake screen, part of the openwashdata cleanup tracked in openwashdata/owdata#20. The package already has a Zenodo deposit, so the gap was the citation files, not a new deposit.

  • CITATION.cff and inst/CITATION written by washr 1.1.1 with the Zenodo concept DOI 10.5281/zenodo.14754016 (they carried the v1.0.1 version DOI) and type dataset instead of software.
  • DESCRIPTION gains X-schema.org-keywords and the spatial and temporal coverage (Global; 2025, the publication year of the WHO glossary; the data carry no date column); pkgdown/templates/in-header.html carries the JSON-LD from washr::update_metadata().
  • The pkgdown workflow deploys the site to gh-pages and docs/ is no longer tracked. The site url stays the Pages URL from the search fix in Fix the install failure and the site search links #3, so the search links keep resolving. After the first deploy on main, switch the Pages source from main/docs to gh-pages.
  • R CMD check workflow (washr template) runs on dev and main; README gains the check badge.
  • Package-specific: the 221 definition pages move from vignettes/ to vignettes/articles/ (their file names with spaces made R CMD check warn); page URLs are unchanged. The Themes page linked a missing "Monitoring and evaluation framework" page; it now links the "Monitoring and evaluation (M&E) framework" page. The README licence link held an unfilled template placeholder.

The data are unchanged. Version 1.0.2 with NEWS.md: the v1.0.1 Zenodo record was cut while DESCRIPTION said 0.1.0. Problems in the extracted glossary text are with the maintainer in #5.

Check script: 0 required failures. R CMD check: 0 errors, 0 warnings, 1 note (CRAN incoming feasibility only).

PII: glossary terms, definitions and thematic areas from a WHO publication; no records about people, no names, phone numbers or IDs; the maintainer email stays. Signed off by Lars Schöbitz on 2026-09-23 (standing decision for the D10 to D14 sweep).

Zenodo record edits: #4.

Test plan

  • pkgreview check script, 0 required failures
  • rcmdcheck (--as-cran, no manual): 0 errors, 0 warnings
  • Local pkgdown build: articles at the same URLs, search index points at the Pages URL
  • After merge: pkgdown deploy succeeds and the Pages source is switched to gh-pages

larnsce and others added 6 commits September 23, 2026 22:25
…oncept DOI

X-schema.org-keywords (open data, washdata, glossary, health data,
health statistics, public health indicators, data governance, WHO);
spatial coverage Global and temporal coverage 2025, the publication year
of the WHO Glossary of health data, statistics and public health
indicators (the data carry no date column). CITATION.cff and
inst/CITATION are rewritten by washr::update_citation() with the Zenodo
concept DOI 10.5281/zenodo.14754016 instead of the v1.0.1 version DOI,
and type dataset instead of software; CITATION.cff is build-ignored.
Config/Needs/website lists the packages the README chunks load.

Assisted-by: Claude claude-opus-5-5
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
pkgdown/templates/in-header.html carries the JSON-LD from
washr::update_metadata(); the pkgdown workflow deploys the site to
gh-pages, and docs/ is ignored and no longer tracked (switch the Pages
source from main/docs to gh-pages after the first deploy). The site url
in _pkgdown.yml already points at the Pages site since the search fix
of #1, so search links keep resolving on the deployed site. The funding
sidebar text sits on one line to match the org template. README: the
DOI badge, and the licence link that held the unfilled
{{{packagename}}} placeholder; re-knit, its citation output now shows
the concept DOI.

Assisted-by: Claude claude-opus-5-5
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
The workflow triggered on main and master only; the washr template adds
dev to the push and pull request triggers and workflow_dispatch. README
gains the R-CMD-check badge.

Assisted-by: Claude claude-opus-5-5
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Metadata-only patch after the v1.0.1 Zenodo record, which was cut while
DESCRIPTION still said 0.1.0; the citation files carry the concept DOI
and the dataset type, and NEWS.md starts with the 1.0.2 entry and the
two earlier GitHub releases. Citation files, JSON-LD header and README
regenerated.

Assisted-by: Claude claude-opus-5-5
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
The 221 definition pages sat directly in vignettes/ with spaces in their
file names and no vignette engine, which R CMD check reports as a
warning (non-portable file names). They move to vignettes/articles/,
which is build-ignored, and _pkgdown.yml lists them as articles/<term>;
pkgdown still writes them to articles/<term>.html, so the page URLs and
the search links stay the same. The Themes vignette stays in vignettes/.
The generator script in data-raw/ writes to the new folder. Themes
linked the "Monitoring and evaluation framework" page, which does not
exist; the link now points at "Monitoring and evaluation (M&E)
framework". The Python/ folder is build-ignored.

Assisted-by: Claude claude-opus-5-5
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@larnsce
larnsce merged commit 7cc7dcd into main Sep 24, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant