Load a model from basic files.

Usage

load_model(
  model_name,
  type,
  path = getOption("floodam_building_path"),
  file_name = getOption("floodam_building_file_name"),
  type_building = getOption("floodam_building_type_building"),
  version_building = NULL,
  inspect = TRUE,
  verbose = getOption("floodam_building_verbose")
)

Arguments

model_name: character, name of the model
type: character, type of the model
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 to be used
inspect: boolean, shall information from building file be inspected according to pattern? Default to TRUE
verbose: boolean, shall floodam tells what it is doing, default to getOption("floodam_building_verbose")

Value

An object of class "model" with those characteristics

name: character, name of the model
type: character, type of the model
path: list, useful paths to read and write data
file_name: list, useful file names to read and write data
building: list, representation of data stored in the building file
furniture: data frame of data in furniture.csv file

Examples


  model_path = list(
    data = system.file("extdata", package = "floodam.building"),
    output = tempdir()
  )
  load_model(model = "adu_t", type = "adu", path = model_path)
#> Loading model 'adu_t'...
#> 	- Structure of building.xml of 'adu_t' has been successfully checked
#> 	... successful