Plot comparison of damaging functions

plot_damaging_comparison() plots a comparison of damaging functions from a list of model objects.

Usage

plot_damaging_comparison(
  x,
  d_select = getOption("floodam_building_d_select")[1:2],
  h_range = NULL,
  d_range = NULL,
  path = NULL,
  file_name = "damaging_comparison",
  view = c("absolute", "surface"),
  detail = "total",
  screen_nav = NULL,
  ...
)

Arguments

x

object of class damaging (list of arrays giving simple damaging function)

d_select

selected values of durations where to make some focus. At list one value

h_range

height range for making the graphs. Default to NULL, and so analyzing dam

d_range

duration range for making the graphs. Default to NULL, and so analyzing dam

path

path for saving the result. Default to NULL, nothing is saved, graph is displayed

file_name

name of the elementary component processed. Default to NULL, no title

view

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

detail

character, defines what type of simple damaging will be plotted. Default to "total".

screen_nav

integer, managing screens for plot_mosaic()

...

a list of extra-parameters (unused)

Value

A message to retrieve the file used to save the plot, if any.

Examples

 adu_l = analyse_model(adu_l, stage = c("extract", "damaging"))
#> Extracting building information for 'adu_l'...
#> 	- extracted:
#> 		- parameter
#> 		- storey
#> 		- room
#> 		- wall
#> 		- opening
#> 		- coating
#> 	- missing (not found):
#> 		- furniture
#> 	... Informations successfully extracted for 'adu_l'
#> Computing some values for 'adu_l'...
#> 	... Informations successfully extracted for 'adu_l'
#> Computing damage for 'adu_l'...
#> 	... Damaging successfully computed for 'adu_l'
#> End of analysis for 'adu_l'. Total elapsed time 0.53 secs
#> More information availabe at /tmp/R-test/model/adu/adu_l/adu_l.log
adu_t_basement = analyse_model(adu_t_basement, stage = c("extract", "damaging"))
#> Extracting building information for 'adu_t_basement'...
#> 	- extracted:
#> 		- parameter
#> 		- storey
#> 		- room
#> 		- wall
#> 		- opening
#> 		- coating
#> 		- furniture
#> 	- missing (not found):
#> 	... Informations successfully extracted for 'adu_t_basement'
#> Computing some values for 'adu_t_basement'...
#> 	... Informations successfully extracted for 'adu_t_basement'
#> Computing damage for 'adu_t_basement'...
#> 	... Damaging successfully computed for 'adu_t_basement'
#> End of analysis for 'adu_t_basement'. Total elapsed time 0.89 secs
#> More information availabe at /tmp/R-test/model/adu/adu_t_basement/adu_t_basement.log
x = list(adu_t = adu_t, basement = adu_t_basement, adu_l = adu_l)

plot_damaging_comparison(x, path = tempdir())
#> Comparison of 3 damaging functions saved in /tmp/RtmpaJW9id/damaging_comparison_absolute_total.pdf
#> [1] "/tmp/RtmpaJW9id/damaging_comparison_absolute_total.pdf"
plot_damaging_comparison(x, view = "surface", detail = "building", path = tempdir())
#> Comparison of 3 damaging functions saved in /tmp/RtmpaJW9id/damaging_comparison_surface_building.pdf
#> [1] "/tmp/RtmpaJW9id/damaging_comparison_surface_building.pdf"
plot_damaging_comparison(x, view = "surface", detail = "building", path = tempdir())
#> Comparison of 3 damaging functions saved in /tmp/RtmpaJW9id/damaging_comparison_surface_building.pdf
#> [1] "/tmp/RtmpaJW9id/damaging_comparison_surface_building.pdf"
plot_damaging_comparison(x, view = "surface", d_select = 48, path = tempdir())
#> Comparison of 3 damaging functions saved in /tmp/RtmpaJW9id/damaging_comparison_surface_total.pdf
#> [1] "/tmp/RtmpaJW9id/damaging_comparison_surface_total.pdf"