compare_one_reserve_one_event: compare_one_reserve_one_event() produce daily stat time...

View source: R/compare_one_reserve_one_event.R

compare_one_reserve_one_eventR Documentation

compare_one_reserve_one_event() produce daily stat time series for single event at one reserve

Description

compare_one_reserve_one_event() produce daily stat time series for single event at one reserve

Usage

compare_one_reserve_one_event(
  var_in,
  data_path,
  storm_nm = NULL,
  storm_start = NULL,
  storm_end = NULL,
  reserve = NULL,
  wq_sites = NULL,
  met_sites = 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).

storm_nm

name of storm event (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).

reserve

3 digit reserve code (string).

wq_sites

comma separated list of wq stations to plot. if left blank, all active stations from reserve will be plotted. (string).

met_sites

comma separated list of met stations to plot. if left blank, all active stations from reserve will be plotted. (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

tables are generated and saved in /output/wq/compare_one_reserve_one_event/ and /output/met/compare_one_reserve_one_event/

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.