Skip to content

README: plain-language rewrite with a figure, NOTICE, grouped reference (#142) - #152

Merged
NewGraphEnvironment merged 13 commits into
mainfrom
142-readme-add-daily-point-temperatures-and
Oct 17, 2026
Merged

NewGraphEnvironment merged 13 commits into
mainfrom
142-readme-add-daily-point-temperatures-and

Conversation

@NewGraphEnvironment

Copy link
Copy Markdown
Owner

Summary

  • README rewritten to the org README convention, in plain language. The opening now says what cd measures and what restoration decision it informs. It adds daily point temperatures and the any-series baselines, one clause each. There is a figure (Kootenay Lake annual temperature departure from a 1951–1980 baseline, with its trend) built by the new data-raw/readme_figure.R. The single example uses a realistic baseline and shows its real output, from the same run. The function table (and with it the internal cd_stac_item()), the roadmap, the caching section and the data inventory are removed; the VPD unit fix stays in NEWS. 962 → 626 words.
  • The texts that travel with it match. The DESCRIPTION Title/Description, the README tagline and the GitHub About now say the same thing. The CITATION.cff workflow passes authors_roles = c("aut", "cre", "cph"), so New Graph Environment Ltd. becomes a citation author on the next DESCRIPTION push.
  • The reference index is grouped by purpose in _pkgdown.yml, so the docs site no longer shows a flat alphabetical list. The CDS download route (cd_fetch, cd_derive) has its own section, apart from the functions the published catalog is built with.
  • New NOTICE.md. It attributes ERA5-Land (CC BY 4.0) and the BC Freshwater Atlas and ecoregion data (Open Government Licence – BC) that the bundled data are built from. It points to Bundled data with unstated licences: example_climate.tif, FWCP Peace boundary, towns and highways #151 for the sources whose licences are not confirmed. NOTICE is added to the pkgdown page allowlist.

Related Issues

Test plan

  • devtools::test(): FAIL 0 | PASS 768 (6 warnings, all from cd_plot_comparison(), which this branch does not touch)
  • pkgdown::check_pkgdown() clean; home page and reference index built locally, figure and NOTICE page render, links rewritten
  • Every function the README names is exported; every link in README and NOTICE answers 200
  • The README example's code is identical to the marked block in data-raw/readme_figure.R
  • Plan review plus 3 /code-check rounds. They ended on an enumeration of all 7 external data sources data-raw/ reads (planning/archive/2026-10-issue-142-*/review-round3.md)

Notes

  • A root NOTICE.md draws an R CMD check "non-standard top-level file" NOTE (link has the same). It is kept so the attribution ships with the data. This repo has no R-CMD-check workflow.
  • The pasted example output and the figure come from the live catalog, so they change when a year is added. CLAUDE.md now says to re-run data-raw/readme_figure.R then.

🤖 Generated with Claude Code

https://claude.ai/code/session_01GignjoKpZADXywTf6pAMgj

NewGraphEnvironment and others added 13 commits October 17, 2026 00:26
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GignjoKpZADXywTf6pAMgj
Opening says what cd measures and what it informs, adds daily point
temperatures and any-series baselines, a figure from committed code,
an example with a 1951-1980 baseline and its real output. Drops the
function table (and internal cd_stac_item()), roadmap and inventories.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GignjoKpZADXywTf6pAMgj
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GignjoKpZADXywTf6pAMgj
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GignjoKpZADXywTf6pAMgj
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GignjoKpZADXywTf6pAMgj
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GignjoKpZADXywTf6pAMgj
@NewGraphEnvironment
NewGraphEnvironment merged commit 50051fb into main Oct 17, 2026
1 check passed
@NewGraphEnvironment
NewGraphEnvironment deleted the 142-readme-add-daily-point-temperatures-and branch October 17, 2026 08:55
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.

README: add daily point temperatures and any-series consumers; drop internal function

1 participant