single_storm_track: single_storm_track

In LimnoTech/SWMPrStorm: Organizing, and Analyzing Estuary Monitoring Data for Storm Events

single_storm_track

Description

single_storm_track

Usage

single_storm_track(
  map_in,
  nerr_site_id = NULL,
  storm_nm = NULL,
  storm_rank = NULL,
  stations = NULL,
  bbox = NULL,
  path_to_shp = NULL,
  path_to_base = NULL,
  lab_loc = NULL,
  scale_pos = "bottomleft",
  skip = NULL
)

Arguments

map_in	.xlsx with all required input variables defined (string).
nerr_site_id	3 digit reserve code (string)
storm_nm	name of storm event (string).
storm_rank	numeric rank of storm for plotting aesthetics. a single storm with rank = 1 will be emphasized. (numeric integer)
stations	comma separated list of stations to plot on map (string)
bbox	comma separated bounding box for map extents (string vector )
path_to_shp	pathway to shapefile for each storm track (string)
path_to_base	pathway to shapefile for the basemap world boundaries (string)
lab_loc	location of labels on the map. optional (string).
scale_pos	location of the scale on th map optional (string)
skip	TRUE/FALSE. If TRUE, function will be skipped (string).

Value

map is generated and saved in /output/maps/

Examples

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

## End(Not run)

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