marsWaterLevelPlot: Observed and Simulated Water Level Plot

In taywater/pwdgsi: Philadelphia Water Department Green Stormwater Infrastructure

Observed and Simulated Water Level Plot

Description

Create a plot of observed and simulated (optional) water level

Usage

marsWaterLevelPlot(
  event,
  structure_name,
  storage_depth_ft,
  obs_datetime,
  obs_level_ft,
  level_names = NA,
  sim_datetime = NA,
  sim_level_ft = NA,
  orifice_show = FALSE,
  orifice_height_ft = NULL,
  datetime_2 = NA,
  level_ft_2 = NA,
  datetime_3 = NA,
  level_ft_3 = NA,
  datetime_4 = NA,
  level_ft_4 = NA,
  metrics_show = FALSE,
  obs_RSPU,
  sim_RSPU,
  obs_infil_inhr,
  sim_infil_inhr,
  obs_draindown_hr,
  sim_draindown_hr,
  obs_overtopping,
  sim_overtopping
)

Arguments

event	Rainfall gage event ID
structure_name	SMP ID and OW Suffix
storage_depth_ft	Maximum storage depth of system (ft)
obs_datetime	Vector of POSIXct datetimes for observed dataset
obs_level_ft	Vector of water level data (ft), corresponding to obs_datetime
sim_datetime	Vector of POSIXct datetimes for simulated dataset (optional)
sim_level_ft	Vector of water level data (ft), corresponding to sim_datetime (optional)
orifice_show	TRUE if user wants to include the orifice height as dashed line on plot (optional)
orifice_height_ft	Orifice height, in feet (optional)
datetime_2	Vector of POSIXct datetimes for observed dataset used for comparison
level_ft_2	Vector of water level data (ft) used for comparison
datetime_3	Vector of POSIXct datetimes for observed dataset used for comparison
level_ft_3	Vector of water level data (ft) used for comparison
datetime_4	Vector of POSIXct datetimes for observed dataset used for comparison
level_ft_4	Vector of water level data (ft) used for comparison
metrics_show	Bool, Default FALSE. TRUE if user wants to include a table of metrics on the plot (optional)
...	additional arguments for showing metrics if metrics_show is set to TRUE. See marsMetricsTable

Value

Output is a ggplot2 object of the water level plot.

taywater/pwdgsi documentation built on April 19, 2024, 11:10 a.m.