Skip to contents

plot.model() plots S3 model objects with calls to some lower levels plot facilities.

Usage

# S3 method for class 'model'
plot(
  x,
  device = c("display", "pdf", "png"),
  view = c("top", "front", "damaging"),
  finition = c("check", "presentation"),
  option = c("all", "map"),
  selection = NULL,
  ...
)

Arguments

x

an object of class model

device,

character, defines way of plotting. Three options: "display", "pdf" or "png". Default to "display".

view,

vector of character, defines which view shall be plotted. Three options: "top", "front" or "damaging". Default to "top" and "front".

finition,

character, defines type of finishing for plotting. Two options: "check" or "presentation". Default to "check".

option,

character, defines what type of damaging will be plotted. Two options: "all" or "total". Default to "all".

selection,

vector for selecting buildings to be displayed. Default to NULL: all buildings are selected.

...

some extra parameters (unused)

Value

Nothing

Details

#' plot.model() is a high level function that dealswith several parameters.

  • device controls if the plot should be displayed (value display) or saved in either a pdf or png file.

  • view controls what type of plot should be used:

    • top will show a representation of the model from a top perspective. This is useful to have a general look at the model. It uses plot_building_top_02().

  • front will show a representation of the model from a front perspective. This is useful to control if all walls of each rooms are correctly set, and if opening heights are consistent. It uses plot_building_front_02().

  • damaging will show the resulting damaging function from classical hypothesis (water height outside the model is the same as inside). It uses plot.damaging applied to the absolute damaging slot.

  • finition is useful for top view. It should put room names instead of room id.

  • option is useful for damaging view.