Analyse a model. — analyse_model • floodam.building

Analyse a model.

analyse_model(
  model,
  type = "",
  stage = "",
  hazard_range = getOption("floodam_building_hazard_range"),
  path = getOption("floodam_building_path"),
  file_name = getOption("floodam_building_file_name"),
  type_building = getOption("floodam_building_type_building"),
  version_building = NULL,
  verbose = getOption("floodam_building_verbose"),
  dam_by_room = FALSE
)

Arguments

model: either a character, name given to the model or an object of class model
type: character, type of model that is loaded, default to ""
stage: character, what are the stages that should be done, default to nothing.
hazard_range: if damaging are calculated, gives the range for hazard, default to getOption("floodam_building_hazard_range")
path: list of useful paths, default to getOption("floodam_building_path")
file_name,: list of useful file names, default to getOption("floodam_building_file_name")
type_building: character, type of building file (building or yaml)
version_building: character, version of building model to be used
verbose: boolean, will floodam tells what it is doing, default to getOption("floodam_building_verbose")
dam_by_room: logical. Should the damage functions be computed by room? Default to FALSE

Value

an object of class model

Examples

if (FALSE) {
load_model("test", "dwelling")
}