Skip to content

README: describe what drift does today, with a map of change (#105) - #110

Merged
NewGraphEnvironment merged 9 commits into
mainfrom
105-readme-describe-accuracy-assessment-brea
Oct 18, 2026
Merged

NewGraphEnvironment merged 9 commits into
mainfrom
105-readme-describe-accuracy-assessment-brea

Conversation

@NewGraphEnvironment

Copy link
Copy Markdown
Owner

Fixes #105

What changed

  • README rewritten in the order the README convention sets: hex sticker with alt text, lifecycle badge, tagline, a three-sentence opening, a map, installation, an example, Learn more, Ecosystem, Data and methods, Citation and license. The opening describes what drift does: it fetches land cover, compares it between two dates and across the annual series, and turns the change into maps, tables and polygons. Checking change (Sentinel-2, Esri Wayback, accuracy sampling) and overlay tags get one sentence. The issue's "what it does by stage" list is folded into the opening rather than added as a section, following the direction to keep the detail light.
  • README map: man/figures/readme-change.png, built by data-raw/readme_figure.R from the bundled Neexdzii Kwa rasters. It shows 2017→2023 change in four groups (trees to rangeland, crops to rangeland, became water, other) at 50% opacity over muted Esri World Imagery. Colours and opacity come from inst/cartography/drift_readme.csv.
    • The published stac_floodplains_bc scheme colours each patch by the class it became. Rendered over imagery, it nearly hid the change, so the README keeps its own groups.
  • Example: a bundled-data run of dft_rast_classify() and dft_rast_transition(), shown with the output it really prints. It needs no network.
  • All four documents are listed: two vignettes and two articles.
  • Docs URL is now https://www.newgraphenvironment.com/drift/ in README, DESCRIPTION (still the second URL, so inst/CITATION keeps the repo URL) and _pkgdown.yml. newgraphenvironment.github.io/drift/ redirects there.
    • With a /drift/ path, pkgdown writes no CNAME.
    • link, flooded, gq and fresh still use github.io in DESCRIPTION, so drift now differs from them.
  • DESCRIPTION Description now matches the opening and ends "Under active development." The Title is kept. man/drift-package.Rd is regenerated.
  • CITATION.cff workflow passes authors_roles = c("aut", "cre", "cph"), so New Graph Environment Ltd. stays an author when the bot regenerates the file after merge.
  • pkgdown reference index is grouped into eight sections by purpose. Each of the 33 exports appears exactly once, and check_pkgdown() is clean.

Checks

  • Tests: [ FAIL 0 | WARN 0 | SKIP 19 | PASS 1709 ].
  • All 24 README links return 200. Every function the README names is exported.
  • The map re-renders byte-identical from a git archive HEAD copy. The PNG is RGB with no alpha channel, and the cartography self-review was done at 700 px.
  • /code-check branch: 4 rounds (2, 0, 2, 0 findings): 3 fixed, 1 accepted (citation("drift") and CITATION.cff list authors and URL differently; both valid), none inside an earlier fix. Fixes: the caption's "of 123 ha" read as the floodplain's area (the outline is 104 ha; 123 ha is the cells it touches); "smaller transitions" was false for single transitions; a script comment said fourteen colours where ten are change. Plan review folded in beforehand (attribute wording, gdalcubes note, ecosystem table, reference grouping).
  • README length: 269 → 727 words (wc -w). The prose is short. Most of the growth is the ecosystem table, the example code and its output, and alt text.

After merge

  • Set the GitHub About and homepage to match the tagline:
    gh repo edit NewGraphEnvironment/drift --description "Detecting riparian and inland floodplain transitions: track land cover change within floodplains over time" --homepage https://www.newgraphenvironment.com/drift/
    
  • soul#446 is a 404 link to a drift vignette in the shared cartography convention. It was found here and is fixed at its source.

Relates to NewGraphEnvironment/sred-2025-2026#16

🤖 Generated with Claude Code

https://claude.ai/code/session_01PRhUJsuKABLfpBGktPoiBN

NewGraphEnvironment and others added 9 commits October 17, 2026 00:20
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01PRhUJsuKABLfpBGktPoiBN
data-raw/readme_figure.R draws man/figures/readme-change.png from the bundled
Neexdzii Kwa rasters: change coloured by what changed to what, over muted
Esri World Imagery, colours from inst/cartography/drift_readme.csv.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01PRhUJsuKABLfpBGktPoiBN
Opening on fetch, compare, and turn change into maps, tables and polygons,
with one sentence on imagery checks, accuracy and overlay tags. Adds the map,
lifecycle badge, a bundled-data example with real output, all four articles,
the ecosystem table, data and methods, citation and license. Docs links use
www.newgraphenvironment.com/drift/, where the site is served.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01PRhUJsuKABLfpBGktPoiBN
Description follows the README opening. The site url is
www.newgraphenvironment.com/drift/, where github.io redirects. The
CITATION.cff workflow keeps New Graph Environment Ltd. as an author.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01PRhUJsuKABLfpBGktPoiBN
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01PRhUJsuKABLfpBGktPoiBN
Change polygons draw at 50% so the imagery shows through; the opacity is
fill_opacity in drift_readme.csv. The caption's 123 ha is the mapped cells,
not the floodplain outline's 104 ha.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01PRhUJsuKABLfpBGktPoiBN
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01PRhUJsuKABLfpBGktPoiBN
@NewGraphEnvironment
NewGraphEnvironment merged commit 6b05aa8 into main Oct 18, 2026
1 check passed
@NewGraphEnvironment
NewGraphEnvironment deleted the 105-readme-describe-accuracy-assessment-brea branch October 18, 2026 02:26
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: describe accuracy assessment, break detection and change attribution, not just fetch-classify-summarize

1 participant