names(getOption("floodam.cba"))
#> [1] "stake_dam_admissible" "stake_com_admissible"
#> [3] "stake_evo_admissible" "stake_dam_mandatory"
#> [5] "stake_com_mandatory" "stake_dam_typology"
#> [7] "stake_com_typology" "project_col"
#> [9] "action_col" "cost_during"
#> [11] "cost_after" "flood_dim"
#> [13] "event_dim" "scenario_dim"
#> [15] "damage_dim" "complement_dim"
#> [17] "evolution_dim" "uncertainty_col"
#> [19] "uncertainty_type_admissible" "uncertainty_default"
#> [21] "horizon_start" "horizon_end"
#> [23] "rate" "reference"
#> [25] "sobol_method" "n_uncertainty"
#> [27] "n_boot"
Options du package
2026-11-13
Note
An English version of this article is available: Package options.
Consulter et modifier les options
Au chargement de floodam.cba, deux options R sont initialisées :
-
floodam.cba.verbose: booléen (par défautTRUE) contrôlant l’affichage des messages d’information dans la console ; -
floodam.cba: une liste nommée regroupant l’ensemble des paramètres par défaut utilisés pour l’importation, les calculs ACB et l’analyse d’incertitude/sensibilité.
Vous pouvez consulter la configuration active à tout moment avec getOption() :
Pour modifier une ou plusieurs options sans écraser le reste de la liste, modifiez une copie de getOption("floodam.cba") puis réassignez-la avec options() :
La liste de référence complète est également disponible via ?floodam.cba-options.
Options générales et d’actualisation
Ces options définissent le cadre temporel et la situation de référence :
-
horizon_start(par défaut0) : année initiale de l’horizon d’analyse ; -
horizon_end(par défaut50) : année finale de l’horizon d’analyse ; -
rate(par défaut"official") : schéma de taux d’actualisation utilisé pardiscount_rate()(ex."official","constant","quinet2013","cgp2005") ; -
reference(par défaut"baseline") : nom du projet de référence servant de contrefactuel pour le calcul des dommages évités et des indicateurs ACB.
Options d’analyse d’incertitude et de sensibilité
Ces options pilotent prepare_uncertainty(), prepare_sa() et perform_sa() :
-
n_uncertainty(par défaut1000) : taille par défaut de l’échantillon de base Monte Carlo utilisé parprepare_sa()etperform_sa(). Augmentern_uncertaintyaméliore la précision des quantiles empiriques et des indices de Sobol (au prix de évaluations du modèle) ; -
n_boot(par défaut100) : nombre par défaut de réplications bootstrap utilisées parsensitivity::sobolmartinezpour estimer les intervalles de confiance des indices de Sobol ; -
sobol_method(par défaut"sobolmartinez") : méthode d’estimation des indices issue du package sensitivity ; -
uncertainty_default: plages d’incertitude par défaut appliquées automatiquement parprepare_uncertainty()lorsqu’aucun ongletuncertaintyn’est fourni :-
cost:min = 0,max = 0.5,type = "relative"(0 % à +50 % sur les coûts) ; -
flood:min = -0.3,max = 0.3,type = "relative"( sur les périodes de retour, tronquées automatiquement pour éviter tout chevauchement) ; -
hydraulic:min = -0.3,max = 0.3,type = "relative"( sur l’efficacité hydraulique) ; -
stake_dam:min = -0.5,max = 0.5,type = "relative"( sur les estimations de dommages) ;
-
-
uncertainty_coletuncertainty_type_admissible: colonnes attendues (c("parameter", "min", "max", "type")) et types de variation admissibles (c("relative", "absolute")) vérifiés lors de l’importation d’unCase.
str(getOption("floodam.cba")[c(
"n_uncertainty", "n_boot", "sobol_method", "uncertainty_default"
)])
#> List of 4
#> $ n_uncertainty : num 10000
#> $ n_boot : num 100
#> $ sobol_method : chr "sobolmartinez"
#> $ uncertainty_default:List of 4
#> ..$ cost :List of 3
#> .. ..$ min : num 0
#> .. ..$ max : num 0.5
#> .. ..$ type: chr "relative"
#> ..$ flood :List of 3
#> .. ..$ min : num -0.3
#> .. ..$ max : num 0.3
#> .. ..$ type: chr "relative"
#> ..$ hydraulic:List of 3
#> .. ..$ min : num -0.3
#> .. ..$ max : num 0.3
#> .. ..$ type: chr "relative"
#> ..$ stake_dam:List of 3
#> .. ..$ min : num -0.5
#> .. ..$ max : num 0.5
#> .. ..$ type: chr "relative"Enjeux, typologies et schémas d’entrée
Les autres entrées de getOption("floodam.cba") définissent les règles métier vérifiées par import_case() et lors de la validation d’un objet Case :
-
Enjeux et typologies :
-
stake_dam_admissible,stake_dam_mandatory,stake_dam_typology: enjeux de dommages directs admissibles et obligatoires (ex."activity","agriculture","dwelling","public") et leur regroupement en"urban","rural"et"other"; -
stake_com_admissible,stake_com_mandatory,stake_com_typology: enjeux complémentaires admissibles et obligatoires (ex."inhabitant","employee") ; -
stake_evo_admissible: catégories d’évolution temporelle admissibles (c("urban", "rural", "other")).
-
-
Colonnes et dimensions attendues :
-
project_col,action_col,cost_during,cost_after: noms de colonnes et catégories de coûts attendus dans les tables de projets et d’actions ; -
flood_dim,event_dim,scenario_dim,damage_dim,complement_dim,evolution_dim: noms des dimensions des tableaux multidimensionnels des objetsSector.
-