Skip to contents

Extract information of a model from building and furniture components

extract_building_information.Rd

extract_building_information() extracts all information at buiding levels to update tabular views of what is present in the model.

Usage

extract_building_information(
  model,
  verbose = getOption("floodam_building_verbose")
)

Arguments

model

an object of class model

verbose

logical, default to getOption("floodam_building_verbose")

Value

A list of data.frame giving a tabular view of elements present in the object model.

Details

Elements returned are:

  • parameter: list of data frames, giving information on some elementary components used in the model

  • storey: data frame, information at storey level.

  • room: data frame, information at room level.

  • wall: data frame, information at wall level.

  • opening: data frame, information at opening level.

  • coating: data frame, information at coating level.

  • furniture: data.frame, information at furniture level. This data.frame is taken from what already desbrided in model, and adjusted according to information in building.

Examples


data_table = extract_building_information(adu_t)
#> Extracting building information for 'adu_t'...
#> 	- extracted:
#> 		- parameter
#> 		- storey
#> 		- room
#> 		- wall
#> 		- opening
#> 		- coating
#> 		- furniture
#> 	- missing (not found):
#> 	... Informations successfully extracted for 'adu_t'