plot hydraulic views

plot.hydraulic() plots S3 hydraulic objects with call to a lower level plot facility. It enables a compound view of hydraulic stats.

Usage

# S3 method for class 'hydraulic'
plot(
  x,
  path = NULL,
  file_name = NULL,
  view = c("height", "level", "discharge"),
  selection = "all",
  screen_nav = NULL,
  ...
)

Arguments

x

an object of class hydraulic

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 which view shall be plotted, within 3 options: "height", "level", "discharge"

selection

character, select the rooms/facades or openings for which curves shall be plotted

screen_nav

integer, managing screens for plot_mosaic()

...

some extra parameters (unused)

Value

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

Details

This is a new method for the plot function. It can be used to display graphs or save graphs in different formats (.png and .pdf). The .png is in a lower resolution than .pdf but is much lighter.

3 differents views are proposed:

• height: it represents the evolution of water height (m) for each room, the reference being the elevation of each room.

• level: it represents the evolution of water height (m) for each room, the reference being the elevation of the whole model.

• discharge: it represents the evolution of discharge (m³/s) for each opening.

Examples

plot(adu_t_hydraulic, path = tempdir())
#> [1] "Composite hydraulic view (height, level, discharge) saved in /tmp/RtmpaJW9id/hydraulic.pdf"
plot(adu_t_hydraulic, view = "height", path = tempdir())
#> [1] "Water height view save in /tmp/RtmpaJW9id/water_height.pdf"
plot(adu_t_hydraulic, view = "height", selection = c("room_1"), path = tempdir())
#> [1] "Water height view save in /tmp/RtmpaJW9id/water_height.pdf"
plot_mosaic(list(adu_t_hydraulic, adu_t_hydraulic), path = tempdir())
#> [1] "Mosaic plot saved in /tmp/RtmpaJW9id/mosaic.pdf"