Skip to content

Commit bfeacf5

Browse files
Drop internal rtj doc reference from fl_dem_aoi() docs; bump to 0.3.2
Remove the `rtj/docs/dem-sources.md` pointer from fl_dem_aoi() roxygen, its generated man page, and NEWS. MRDEM-30 is now described as the default DEM source without referencing a private doc readers can't access. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_019FSpV4wdm2aY2rQ4qEWrTQ
1 parent 8d169ce commit bfeacf5

4 files changed

Lines changed: 10 additions & 6 deletions

File tree

DESCRIPTION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Package: flooded
22
Title: Portable Floodplain Delineation from DEM and Stream Network
3-
Version: 0.3.1
3+
Version: 0.3.2
44
Authors@R: c(
55
person("Allan", "Irvine", , "al@newgraphenvironment.com", role = c("aut", "cre"),
66
comment = c(ORCID = "0000-0002-3495-2128")),

NEWS.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
1+
# flooded 0.3.2
2+
3+
- Drop the internal `rtj/docs/dem-sources.md` reference from `fl_dem_aoi()` documentation and NEWS — MRDEM-30 is described as the default DEM source without pointing readers at a private doc they can't access.
4+
15
# flooded 0.3.1
26

37
- Fix Parsnip River Watershed Group vignette: corrected geography (the south-east inset is the headwaters around Arctic Lake on the continental divide, not the Williston-bound confluences) and switched all prose mentions from `PARS` to "Parsnip River Watershed Group".
48

59
# flooded 0.3.0
610

7-
- New `fl_dem_aoi()` — AOI-driven DEM fetch helper. Defaults to MRDEM-30 via `/vsicurl/` (the rtj-doc-settled choice for watershed-scale BC work) but accepts any local path, `/vsicurl/` URL, or `/vsis3/` S3 URL via `source =`. Buffered crop happens in the source raster's CRS, reprojection after crop. Replaces hand-rolled per-project DEM plumbing (#34).
11+
- New `fl_dem_aoi()` — AOI-driven DEM fetch helper. Defaults to MRDEM-30 via `/vsicurl/` (a sensible default for watershed-scale BC work) but accepts any local path, `/vsicurl/` URL, or `/vsis3/` S3 URL via `source =`. Buffered crop happens in the source raster's CRS, reprojection after crop. Replaces hand-rolled per-project DEM plumbing (#34).
812
- New `vignettes/pars-floodplain.Rmd` — watershed-scale showcase running `fl_dem_aoi()` + `fl_valley_confine()` end-to-end on the Parsnip River WSG (5,597 km²). Designed to port to a bookdown report appendix (#34).
913
- New `data-raw/wsg_vignette_data.R` — generic, parameterised by `wsg <- "PARS"`. Re-runs the full pipeline for any 4-letter BC watershed group, namespaces outputs by WSG code (#34).
1014
- bcfishpass model version + date are cached at data-raw time as `inst/vignette-data/<wsg>_meta.rds` so the vignette renders without a database connection (#34).

R/fl_dem_aoi.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
#' Returns a `SpatRaster` of elevation cropped to a buffered AOI. Source is a
44
#' local file, an HTTP COG (`/vsicurl/`), or an S3 COG (`/vsis3/`). Defaults to
55
#' MRDEM-30 — NRCan's Medium-Resolution Digital Elevation Model (30 m, all of
6-
#' Canada, public S3, no auth) — the source-of-truth choice for watershed-scale
7-
#' BC floodplain work as decided in `rtj/docs/dem-sources.md`.
6+
#' Canada, public S3, no auth) — a sensible default for watershed-scale BC
7+
#' floodplain work.
88
#'
99
#' @param aoi An `sf` or `sfc` object — polygon, lines, or points. Buffered by
1010
#' `buffer` (via [sf::st_buffer()]) before crop. To crop tightly along a

man/fl_dem_aoi.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)