Data Package Review: Documentation

[larnsce]

Review Checklist

This is step 3 of 4 in the openwashdata package review process.

Review standard version: 1.0.0-dev

Prerequisites

• Metadata review (Data Package Review: General Information & Metadata #5) completed and merged to dev
• Data review (Data Package Review: Data Content & Processing #7) completed and merged to dev

Tasks

README

• README.Rmd follows the openwashdata template
• Contains a one-paragraph introduction, 3 to 5 sentences long
• Dynamic content generation works (README.md rebuilds from README.Rmd with devtools::build_readme())
• Installation instructions present
• Data overview with dimensions
• Variable dictionary table rendered
• Each data visualisation has edited human-readable labels (axis labels, legend title), is described in the narrative, and is cross-referenced using its code-chunk label (Example 1 legend was mislabelled Treatment Plant, now Date)
• License section complete
• Citation section complete with author, year, title, DOI (once available), and website URL (no DOI until first release)

Function and data documentation

• Roxygen documentation for all exported functions (not applicable: data-only package, no exported functions)
• All datasets documented with .Rd files that include a clear title, description, usage examples, and a description of each variable (usage examples added)
• Data structures (number of rows and columns) and types clearly described
• Vignettes, if present, live in vignettes/articles/, not directly in vignettes/ (moved)

Website

• _pkgdown.yml follows the standard openwashdata configuration, including the Plausible analytics header (canonical template: skills/pkgreview-core/references/templates/_pkgdown.yml in openwashdata/pkgreview) (reference index added; url corrected to the site address, see openwashdata/pkgreview suggestion)
• Package website builds without errors (pkgdown::build_site())
• Website published on GitHub Pages (main branch, /docs, status built)

Files to review

• README.Rmd, README.md
• _pkgdown.yml
• man/*.Rd
• vignettes/articles/ (if vignettes exist)

Next Steps

1. Run /review-issue [this issue's number] to work on this issue
2. Create a PR to the dev branch
3. After merging, run /create-next-issue to create the next issue

[larnsce]

Completed via PR #10, merged into dev. Closing manually since merges into dev do not trigger GitHub auto-close.