event_timeseries: event_timeseries

View source: R/event_timeseries.R

event_timeseriesR Documentation

event_timeseries

Description

event_timeseries

Usage

event_timeseries(
  var_in,
  data_path = NULL,
  reserve = NULL,
  storm_start = NULL,
  storm_end = NULL,
  view_start = NULL,
  view_end = NULL,
  recovery_start = NULL,
  recovery_end = NULL,
  stn_wq = NULL,
  keep_flags = NULL,
  skip = NULL,
  user_units = NULL
)

Arguments

var_in

.xlsx with all required input variables defined (string).

data_path

pathway to cdmo data folder (string).

reserve

3 digit reserve code (string).

storm_start

YYYY-MM-DD HH:MM:SS start of storm event (string).

storm_end

YYYY-MM-DD HH:MM:SS end of storm event (string).

view_start

YYYY-MM-DD HH:MM:SS first datetime of data to plot (string).

view_end

YYYY-MM-DD HH:MM:SS last datetime of data to plot (string).

recovery_start

YYYY-MM-DD HH:MM:SS start of storm recovery period (string).

recovery_end

YYYY-MM-DD HH:MM:SS end of storm recovery period (string).

stn_wq

station code to analyze. if blank all active stations within reserve will be analyzed (string)

keep_flags

comma separated list of data quality flags that should be kept (string).

skip

TRUE/FALSE. If TRUE, function will be skipped (string).

user_units

User defined units. Set to "English" or "SI". Default CDMO data is in SI units. Not all parameters have common equivalent English units (e.g. concentrations), and therefore not all will be converted.

Value

plots are generated and saved in /output/wq/timeseries_event_recovery/ and /output/met/timeseries_event_recovery/

Examples


## Not run: 
#StormVariables.xlsx is a template variable input file saved in data/
vars_in <- 'data/StormTrackVariables.xlsx'
single_storm_track(var_in = vars_in)

## End(Not run)

LimnoTech/SWMPrStorm documentation built on June 14, 2022, 6:27 p.m.