Skip to contents

Prepare a table of flood hazard parameters combining nominal values and uncertainty ranges for return periods and hydraulic efficiencies.

Usage

prepare_sa_flood(case, project)

Arguments

case

An object of class Case containing period definitions and uncertainty parameters.

project

Character scalar, name of the project (kept for interface consistency).

Value

A data.frame with columns scenario, period_nominal, period_min, period_max, period_type, hydraulic_nominal, hydraulic_min, hydraulic_max, and hydraulic_type.

Details

The function constructs a consolidated table of flood hazard parameters:

  • Return periods: nominal return periods are extracted from case["period"]["global", ] and merged with return period uncertainty bounds (period_min, period_max, period_type) from case["uncertainty"].

  • Hydraulic efficiency: nominal hydraulic efficiency is set to 1 and merged with efficiency uncertainty bounds (hydraulic_min, hydraulic_max, hydraulic_type) from case["uncertainty"].

The project argument is included to ensure an homogeneous interface across prepare_sa_* functions, though flood hazard characteristics are defined globally at the case level.

Author

Frédéric Grelot, frederic.grelot.1994_cran@m4x.org

Examples

case = import_case(
    system.file("extdata", "case", "complete.ods", package = "floodam.cba")
)
#> import Case from /tmp/RtmpvMoJJK/temp_libpath2b69f6f14b9e9/floodam.cba/extdata/case/complete.ods
#>  ... done
project = setdiff(unique(case["project"][["project"]]), "baseline")[1]
prepare_sa_flood(case, project)
#>    scenario period_nominal period_min period_max period_type hydraulic_nominal
#> 1 flood_min       8.333333   5.833333   10.83333    absolute                 1
#> 2 flood_med      75.000000  52.500000   97.50000    absolute                 1
#> 3 flood_max     833.333333 583.333333 1083.33333    absolute                 1
#>   hydraulic_min hydraulic_max hydraulic_type
#> 1          -0.3           0.3       relative
#> 2          -0.3           0.3       relative
#> 3          -0.3           0.3       relative