event_timeseries_precip: event_timeseries_precip

View source: R/event_timeseries_precip.R

event_timeseries_precipR Documentation

event_timeseries_precip

Description

event_timeseries_precip

Usage

event_timeseries_precip(
  var_in,
  data_path,
  reserve = NULL,
  storm_start = NULL,
  storm_end = NULL,
  stn_met = NULL,
  keep_flags = NULL,
  flip = FALSE,
  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).

stn_met

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

keep_flags

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

flip

TRUE/FALSE. If TRUE, the plot axes will flip.

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/met/barplot/

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.