marsMetricsTable: Add metrics to an existing water level or combined plot

In taywater/pwdgsi: Philadelphia Water Department Green Stormwater Infrastructure

Add metrics to an existing water level or combined plot

Description

Return the gpglot object, with the metrics added to the object as a tableGrob annotation

Usage

marsMetricsTable(
  in_plot,
  obs_RSPU,
  obs_infil_inhr,
  obs_draindown_hr,
  obs_overtopping,
  sim_RSPU,
  sim_infil_inhr,
  sim_draindown_hr,
  sim_overtopping
)

Arguments

in_plot	ggplot object without annotative metrics table
obs_RSPU	num, Metric: Observed relative percentage of storage used, see marsPeakStorage_percent (optional)
obs_infil_inhr	num, Metric: Observed infiltration rate in inches per hour, see marsInfiltrationRate_inhr (optional)
obs_draindown_hr	num, Metric: Observed draindown time in hours, see marsDraindown_hr (optional)
obs_overtopping	bool, Metric: Observed overtopping boolean, see marsOvertoppingCheck_bool (optional)
sim_RSPU	num, Metric: Simulated relative percentage of storage used, see marsPeakStorage_percent (optional)
sim_infil_inhr	num, Metric: Simulated infiltration rate in inches per hour, see marsInfiltrationRate_inhr (optional)
sim_draindown_hr	num, Metric: Simulated draindown time in hours, see marsDraindown_hr (optional)
sim_overtopping	bool, Metric: Simulated overtopping boolean, see marsOvertoppingCheck_bool (optional)

Value

Output ggplot object adding metrics when necessary

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