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

View source: R/mars_plotting_functions.R

marsOvertoppingPlotR Documentation

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

marsOvertoppingPlot(
  data,
  design_storm,
  event_dates = NULL,
  event_descriptions = NULL
)

Arguments

data

dataframe, a data frame with a unique row each containing ow_uid, radar_event_uid, ow_suffix, eventdatastart_edt, smp_id, eventavgintensity_inhr, eventpeakintensity_inhr, eventdepth_in, and overtop

design_storm

num, a numeric value fro the design stomr in inches, see marsFetchSMPSnapshot

event_dates

date, a vector of dates to show up as major events in the monitoring locations history (maintenance, retrofit, etc.)

event_descriptions

char, a vector of strings corresponding to labels fo each major event on the plot (eg, "pipe jetting", "filter bag replaced")

Value

Output ggplot object plotting overtopping, event peak intensity, and date


taywater/pwdgsi documentation built on June 14, 2025, 9 p.m.