StormR (version 0.2.1)

getStorm: Extracting a storm

Description

The getStorm() function extracts a specific storm object from a stormsList object.

Usage

getStorm(sts, name, season = NULL)
# S4 method for stormsList
getStorm(sts, name, season = NULL)

Value

A storm object.

Arguments

sts

stormsList

name

character. Name of the storm to extract.

season

numeric vector. Seasons of occurrence of the storms (e.g., c(2020,2022)). In the Southern Hemisphere, the cyclone season extends across two consecutive years. Therefore, to capture the 2021 to 2022 cyclone season both years should be specified, with cyclones assigned for the year #' that originated in. By default all storms occurring since 1980 are extracted.

Examples

#Creating a stormsDataset
# \donttest{
sds <- defStormsDataset()

#Getting storm track data for all storms near New Caledonia
sts <- defStormsList(sds=sds, loi = "New Caledonia")

#Getting `storm` for the tropical cyclone Niran
st <- getStorm(sts, name = "NIRAN")
# }