Load a model from basic files. — load.model • floodam.building

Load a model from basic files.

load.model(
  model.name,
  type,
  path = PATH,
  file.name = FILE.NAME,
  version.xml = NULL,
  inspect = TRUE,
  verbose = VERBOSE
)

Arguments

model.name: character, name of the model
type: character, type of the model
path: list of useful paths, default to PATH
file.name,: list of useful file names, default to FILE.NAME
inspect: boolean, shall information from xml file be inspected according to pattern? Default to TRU
verbose: boolean, shall floodam tells what it is doint, default to VERBOSE
pattern: list giving the expected structure of xml file, default to XML

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
xml: list, representation of data stored in the xml file
furniture: data frame of data in furniture.csv file

Examples

if (FALSE) {
load.model("test", "dwelling")
}