Problem
fl_scenarios() and fl_params() ship pre-defined flood factor scenarios and parameter metadata (#28), but there's no worked example showing how to use them with fl_valley_confine().
Proposed Solution
Add a section to the valley-confinement vignette (or a new vignette) demonstrating:
- Load scenarios with
fl_scenarios()
- Run
fl_valley_confine() at ff=2, ff=4, ff=6 on the bundled test data
- Compare outputs side-by-side — active channel vs functional floodplain vs valley bottom
- Show
fl_params() for parameter documentation lookup
- Demonstrate custom scenario CSV for site-level work (e.g., 1m lidar with smaller thresholds)
This proves the functions work end-to-end and gives users a template for multi-scenario analysis.
Relates to #28
Problem
fl_scenarios()andfl_params()ship pre-defined flood factor scenarios and parameter metadata (#28), but there's no worked example showing how to use them withfl_valley_confine().Proposed Solution
Add a section to the valley-confinement vignette (or a new vignette) demonstrating:
fl_scenarios()fl_valley_confine()at ff=2, ff=4, ff=6 on the bundled test datafl_params()for parameter documentation lookupThis proves the functions work end-to-end and gives users a template for multi-scenario analysis.
Relates to #28