Skip to content

pkgreview mechanical pass: citation DOI, metadata, site from gh-pages - #6

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

larnsce merged 6 commits into
mainfrom
dev

Conversation

@larnsce

@larnsce larnsce commented Sep 18, 2026

Copy link
Copy Markdown
Contributor

Summary

Mechanical pass from the pkgreview 1.6.0 check script and the intake screen, part of the openwashdata cleanup tracked in openwashdata/owdata#20 (this package's deposit issue is #5).

  • CITATION.cff and inst/CITATION rewritten by washr 1.1.1 with the existing Zenodo concept DOI 10.5281/zenodo.10459432 and type dataset, so the weekly harvest lists the package as citable.
  • DESCRIPTION gains X-schema.org-keywords, URL and BugReports (washr::update_description()).
  • _pkgdown.yml follows the openwashdata template (Pages url, Plausible header, funding sidebar); pkgdown/templates/in-header.html carries the JSON-LD from washr::update_metadata().
  • The pkgdown workflow deploys the site to gh-pages; docs/ is no longer tracked. After the first deploy on main, switch the repository's Pages source to the gh-pages branch, or the site is down until then.
  • R-CMD-check triggers include dev.
  • Package-specific: title shortened to 49 characters, the XLSX export ships (a *.xlsx gitignore rule had hidden it), inst/CITATION.bk1 removed, version bumped to 0.0.2 with a NEWS.md (the Zenodo v0.0.1 record was cut while DESCRIPTION said 0.0.0.9000).
    Check script: 0 required failures (advisory items left: spatial and temporal coverage, roxygen @source, categorical case variants). R CMD check: 0 errors, 0 warnings, 0 notes.

Reviewed and approved by the maintainer before merge.

Test plan

  • pkgreview check script, 0 required failures
  • devtools::check(): 0 errors, 0 warnings, 0 notes
  • After merge: pkgdown deploy succeeds and the Pages source is switched to gh-pages

…files with the concept DOI

Title shortened to 49 characters (the review standard asks for under
65), X-schema.org-keywords (open data, washdata, community health, KAP
survey, WASH, Malawi), URL and BugReports through
washr::update_description(), and CITATION.cff plus inst/CITATION
rewritten by washr::update_citation() with the existing Zenodo concept
DOI 10.5281/zenodo.10459432 (deposit of 2024-01-04) and type dataset.

Assisted-by: Claude claude-fable-5-1
The processing script writes inst/extdata/chckapmalawi.xlsx but the
.gitignore rule *.xlsx kept it out of the package; the rule is gone and
the export is generated from the data object. inst/CITATION.bk1 was an
editing backup that shipped with the package.

Assisted-by: Claude claude-fable-5-1
…e from gh-pages

_pkgdown.yml follows the openwashdata template (Pages url, Plausible
header, funding sidebar); pkgdown/templates/in-header.html carries the
JSON-LD from washr::update_metadata(); README rebuilt with the DOI badge
(rAmCharts4 is needed locally for the interactive chart); the pkgdown
workflow deploys the site to gh-pages, and docs/ is no longer tracked
(switch the Pages source to gh-pages after the first deploy).

Assisted-by: Claude claude-fable-5-1
Assisted-by: Claude claude-fable-5-1
Metadata-only patch: the citation files now carry the concept DOI and
the dataset type, the DESCRIPTION the keywords and repository links,
and the site deploys from gh-pages. The Zenodo record for v0.0.1 was cut
while DESCRIPTION still said 0.0.0.9000; 0.0.2 makes the next release
consistent. NEWS.md started with both entries.

Assisted-by: Claude claude-fable-5-1
@larnsce
larnsce merged commit 0df3aac into main Sep 23, 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