marsCombinedPlot: Plot hyetograph and water level plot on the same chart

View source: R/mars_plotting_functions.R

marsCombinedPlotR Documentation

Plot hyetograph and water level plot on the same chart

Description

Return hyetograph and observed and simulated (optional) water level plot for the same rain event on the same chart

Usage

marsCombinedPlot(
  event,
  structure_name,
  obs_datetime,
  obs_level_ft,
  sim_datetime = NA,
  sim_level_ft = NA,
  storage_depth_ft,
  orifice_show = FALSE,
  orifice_height_ft = NULL,
  rainfall_datetime,
  rainfall_in,
  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

chr, rain gage event UID

structure_name

chr, SMP ID and OW Suffix

obs_datetime

vector, POSIXct datetimes corresponding to obs_level_ft

obs_level_ft

vector, water level data (ft), corresponding to obs_datetime

sim_datetime

vector, POSIXct datetimes corresponding to sim_level_ft (optional)

sim_level_ft

vector, water level data (ft), corresponding to sim_datetime (optional)

storage_depth_ft

num, maximum storage depth of system (ft)

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)

rainfall_datetime

vector, POSIXct datetimes corresponding to rainfall_in

rainfall_in

vector, num, rainfall in inches corresponding to rainfall_datetime

metrics_show

bool, Default FALSE. TRUE if user wants to include a table of metrics on the plot (optional)

...

additional arguments for showing metrics (metrics_show = TRUE) and providing multiple water level time series. See marsMetricsTable and marsWaterLevelPlot

Value

Output will be a gridExtra object of the two plots

See Also

marsRainfallPlot, marsWaterLevelPlot


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