res_storm_track: res_storm_track

View source: R/res_storm_track.R

res_storm_trackR Documentation

res_storm_track

Description

res_storm_track

Usage

res_storm_track(
  map_in,
  nerr_site_id = NULL,
  storm_nm = NULL,
  stations = NULL,
  bbox = NULL,
  path_to_shp = NULL,
  lab_loc = NULL,
  scale_pos = "bottomleft"
)

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).

stations

comma separated list of stations to locate on map (string).

bbox

comma separated bounding box for map extents (string vector )

path_to_shp

pathway to shapefile for the reserve boundary (string)

lab_loc

location of labels on the map. optional (string).

scale_pos

location of the scale on th map optional (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'
res_storm_track(map_in = var_in)

## End(Not run)

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