process_input_args: Process inputs to main functions

Description Usage Arguments Value

View source: R/input.R

Description

Processes some of the user's inputs for arguments for main package functions, looks for any errors in input, and determines elements like the year or years of storm data needed based on user inputs.

Usage

1
process_input_args(date_range = NULL, storm = NULL)

Arguments

date_range

A character vector of length two with the start and end dates to pull data for (e.g., c("1999-10-16", "1999-10-18")).

storm

A character string with the name of the storm to pull storm events data for. This string must follow the format "[storm-name]-[4-digit storm year]" (e.g., "Floyd-1999"). Currently, this functionality only works for storms included in the extended hurricane best tracks, which covers 1988 to 2015.

Value

A list with date ranges and storm identification based on user inputs to arguments in a main package function.


noaastormevents documentation built on Jan. 21, 2021, 5:11 p.m.