Skip to content

Review pass: citation files with the concept DOI, shorter title, site from gh-pages, CI - #5

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

larnsce merged 8 commits into
mainfrom
dev

Conversation

@larnsce

@larnsce larnsce commented Sep 24, 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.

  • CITATION.cff and inst/CITATION written by washr 1.1.1 with type dataset and the Zenodo concept DOI 10.5281/zenodo.10878634 (they carried the version DOI of v0.0.0.9000); two stale backups (inst/CITATION.bk1, inst/CITATION.bk2) are gone.
  • DESCRIPTION gains X-schema.org-keywords, the spatial coverage (the nine countries) and the temporal coverage 2017-05-22/2020-12-19 (the range of subdate_wp), URL, BugReports and Config/Needs/website; pkgdown/templates/in-header.html carries the JSON-LD.
  • Title shortened from 88 to 62 characters: Water point functionality in sub-Saharan Africa and South Asia.
  • The dictionary and the roxygen block now document the id column (the one required failure of the dictionary check).
  • _pkgdown.yml follows the openwashdata template; the pkgdown workflow deploys the site to gh-pages and docs/ is no longer tracked. Pages is enabled with the source main /docs, so after the first deploy on main, switch the Pages source to the gh-pages branch, or the site is down until then.
  • R CMD check workflow (washr template) runs on dev and main.
  • README: the pie chart legend labelled the slices in the wrong order and the text concluded that only a small part of the water points are functional; the data show 1333 of 1793 functional, and the README now says so. The licence link lacked blob/main; the map gains alt text.
  • No version bump: DESCRIPTION 0.0.1 matches the current Zenodo version v0.0.1.
  • Maintainer unchanged (Margaux Götschmann).

The data are unchanged. Data follow-ups (date class, a community ID case variant, the 999 code, the photo links) are in #4.

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

PII: water point level records with coordinates from water point monitoring in nine countries; no records per person or household, no names or phone numbers. Signed off by Lars Schöbitz on 2026-09-23 (standing decision for the D10 to D14 sweep). The photo_wp links are listed for a check in #4.

Zenodo: the record is typed Dataset and holds the package archive, but lacks the openwashdata community (#3).

Test plan

  • pkgreview check script, 0 required failures
  • rcmdcheck (--as-cran, no manual): 0 errors, 0 warnings
  • After merge: pkgdown deploy succeeds and the Pages source is switched to gh-pages
  • Zenodo record edits in Zenodo record: the openwashdata community #3

larnsce and others added 8 commits September 24, 2026 06:36
… with the concept DOI

X-schema.org-keywords (open data, washdata, water points,
functionality, rural water supply, water committees and the nine
countries); X-schema.org-spatialCoverage lists the nine countries in the
data (Ethiopia, India, Malawi, Mali, Mozambique, Nepal, Niger, Rwanda,
Uganda) and X-schema.org-temporalCoverage 2017-05-22/2020-12-19, the
range of the submission dates in subdate_wp. URL, BugReports and
Config/Needs/website (the README chunks use tidyverse and kableExtra)
through washr::update_description(); Date stays at 2024-03-11, so the
citation year matches the 2024 deposit.

CITATION.cff and inst/CITATION are rewritten by washr::update_citation()
with type dataset and the Zenodo concept DOI 10.5281/zenodo.10878634.
The files carried the version DOI of v0.0.0.9000
(10.5281/zenodo.10878635), not the one of the current v0.0.1 record.
washr also removed inst/CITATION.bk1 and inst/CITATION.bk2, two stale
backups that were installed with the package.

Assisted-by: Claude claude-opus-5-5
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
The dataset has 52 columns, but the dictionary and the roxygen block
listed 51: id, the row number data_processing.R adds, was missing, the
one required failure of the dictionary check. The man page is
regenerated with roxygen2 8.0.0, which records its version as
Config/roxygen2/version in place of RoxygenNote. The data are unchanged.

Assisted-by: Claude claude-opus-5-5
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
The title goes from 88 to 62 characters: Water point functionality in
sub-Saharan Africa and South Asia. It keeps the place; the title named
no period. Applied in DESCRIPTION and the roxygen block; the man page
and the citation files are regenerated (devtools::document(),
washr::update_citation()). README.md follows with the re-knit.

Assisted-by: Claude claude-opus-5-5
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…e from gh-pages

_pkgdown.yml follows the openwashdata template: the url is the Pages
url instead of the repository url, and the Plausible data-domain loses
its trailing slash (the funding sidebar was already there).
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 to gh-pages after the first deploy).

Assisted-by: Claude claude-opus-5-5
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
… dev and main)

The old workflow ran on main and master only; the washr::setup_ci()
template adds dev to the push and pull_request triggers, the required
tests item of the review standard.

Assisted-by: Claude claude-opus-5-5
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
The pie chart set its legend labels by hand in a different order from
the factor levels, so "Functional" was shown for the "Abandoned or not
functional" slice, and the text below concluded that only a small part
of the water points are functional. The data say the opposite: 1333 of
1793 water points are functional. The hand-set labels are dropped and
the sentence reports the count inline. The licence link lacked
blob/main and returned 404; the map image gains alt text. README.md is
re-knit with the new title in the citation output. The data are
unchanged.

Assisted-by: Claude claude-opus-5-5
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
The top-level copy of the helper script that generated the docs and the
old citation files is an authoring file; ignoring it clears the R CMD
check top-level-file note. references.bib is already covered by the
^references pattern.

Assisted-by: Claude claude-opus-5-5
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@larnsce
larnsce merged commit 59f5f96 into main Sep 24, 2026
11 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