Remove KOTL vignette — peace-fwcp is the canonical worked example#50
Merged
Conversation
The peace-fwcp vignette already showcases the full pipeline (regional + per-ecoregion + day-night asymmetry + interpretation) on a more interesting AOI. KOTL was the original single-watershed example but has been superseded; keeping it costs ~60 s of pkgdown CI time per push and adds /vsicurl/ flake surface that the precompute work in #45 intentionally removed for peace-fwcp. Underlying KOTL data assets stay in inst/extdata/ — README quick-start still uses example_aoi_kotl.gpkg as a small AOI demo. Once snowpack variables land (#48), the plan is to either evolve peace-fwcp to absorb the snow story or re-purpose a single-watershed vignette around the snow-fed hydrology narrative. Both options discussed in #49. Relates to #49
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Removes
vignettes/climate-departure.Rmd(the KOTL vignette) so pkgdown CI stays fast and the package's worked example stays focused onpeace-fwcp, which now demonstrates the full pipeline at a higher fidelity.peace-fwcpalready covers everything KOTL did:peace-fwcpmakes the same scientific point on its own)Keeping KOTL costs ~60 s per pkgdown CI push (it still renders live from S3 — wasn't precomputed in #45) and reintroduces the
/vsicurl/flake surface that #45 intentionally removed forpeace-fwcp.Why now
User-driven decision: "we are showcasing the package well with the 1 vignette currently and the kotl is not as sweet — so functions to distract." The two-vignette state was useful while iterating; one is enough now.
What stays
inst/extdata/example_aoi_kotl.gpkg,context_kotl.gpkg,context_kotl_towns.gpkg— the KOTL polygon assets remain in the package because the README quick-start uses them as a small example AOI.data-raw/example_aoi_kotl.R,data-raw/example_context_kotl.R— generators stay so the bundled assets remain reproducible.Future direction
Captured in #49: once snow-pack variables land (#48), the plan is to either evolve
peace-fwcpto absorb the snow story, or re-purpose a single-watershed vignette around snow-fed hydrology. Decision deferred until #48 ships.Test plan
vignettes/climate-departure.Rmdremoveddata-raw/generators remainRelates to #49
Relates to NewGraphEnvironment/sred-2025-2026#23
🤖 Generated with Claude Code