event_windrose: event_windrose

View source: R/event_windrose.R

event_windroseR Documentation

event_windrose

Description

event_windrose

Usage

event_windrose(
  var_in,
  data_path = NULL,
  reserve = NULL,
  storm_start = NULL,
  storm_end = 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).

reserve

3 digit reserve code (string).

storm_start

YYYY-MM-DD HH:MM:SS (string).

storm_end

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

met_sites

comma separated list of station codes (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

English, or SI (string)

Value

plots are generated and saved in /output/met/windrose/

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.