Skip to contents

S4 object of class Characteristic

Arguments

correction

logical, should correction be made at initialization.

warn

logical, should warning be sent if corrections are made.

Value

Object of class Characteristic.

Slots

flood

character, name of the different flood events considered..

scenario

character, name of the different scenarios considered.

state

character, name of the different states considered.

stake_dam

character, name of the different stakes considered for damage estimation.

stake_com

character, name of the different stakes considered for complement estimation.

stake_evo

character, name of the different stakes considered for evolution estimation.

Author

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

Examples


Characteristic()
#> Warning: Some mandatory stake_dam are missing (activity, agriculture, dwelling, public). They are added.
#> Warning: Some mandatory stake_com are missing (inhabitant, employee). They are added.
#> Warning: Some relevant stake_evo are missing (rural, urban) to be consistent with stake_dam and stake_com. They are added.
#> An object of class "Characteristic"
#>  @flood - 0 modalities:
#>    ""
#>  @scenario - 0 modalities:
#>    ""
#>  @state - 0 modalities:
#>    ""
#>  @stake_dam - 4 modalities:
#>    "activity" "agriculture" "dwelling" "public"
#>  @stake_com - 2 modalities:
#>    "inhabitant" "employee"
#>  @stake_evo - 2 modalities:
#>    "rural" "urban"
if (FALSE) Characteristic(correction = FALSE) # \dontrun{}
Characteristic(state = 1:2)
#> Warning: Some mandatory stake_dam are missing (activity, agriculture, dwelling, public). They are added.
#> Warning: Some mandatory stake_com are missing (inhabitant, employee). They are added.
#> Warning: Some relevant stake_evo are missing (rural, urban) to be consistent with stake_dam and stake_com. They are added.
#> An object of class "Characteristic"
#>  @flood - 0 modalities:
#>    ""
#>  @scenario - 0 modalities:
#>    ""
#>  @state - 2 modalities:
#>    "1" "2"
#>  @stake_dam - 4 modalities:
#>    "activity" "agriculture" "dwelling" "public"
#>  @stake_com - 2 modalities:
#>    "inhabitant" "employee"
#>  @stake_evo - 2 modalities:
#>    "rural" "urban"

char_01 = Characteristic(
 flood = c("flood_min", "flood_med", "flood_max"),
 scenario = c("normal"),
 state = 1:2,
 stake_dam = c("dwelling", "activity", "agriculture", "public"),
 stake_com = c("inhabitant", "employee")
)
#> Warning: Some relevant stake_evo are missing (rural, urban) to be consistent with stake_dam and stake_com. They are added.