Skip to content

Vignette: VCA parameter reference with citations #31

@NewGraphEnvironment

Description

@NewGraphEnvironment

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:

  1. Load scenarios with fl_scenarios()
  2. Run fl_valley_confine() at ff=2, ff=4, ff=6 on the bundled test data
  3. Compare outputs side-by-side — active channel vs functional floodplain vs valley bottom
  4. Show fl_params() for parameter documentation lookup
  5. 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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions