icesVMS (version 1.1.4)

get_sar_map: Download swept area ratio map data

Description

Download a data.frame of surface and subsurface swept area ratio by c-square for a given ICES ecoregion.

Usage

get_sar_map(ecoregion, year = NULL, nyears = NULL, convert2sf = FALSE)

Value

a data.frame with a WKT column for the c-square polygons

Arguments

ecoregion

ICES ecoregion

year

which year to select (see details)

nyears

the number of years to take an average over

convert2sf

logical, default FALSE, should an simple features object be returned if the sf package is installed?

Details

The spatial data.frame contains average annual surface-swept-area-ratio and subsurface-swept-area-ratio averaged over 4 years by default. If year is not specified (NULL) then the present year - 1 is assumed.

Examples

if (FALSE) {
# requires authorization
sar_map <- get_sar_map("Celtic Seas", 2021, convert2sf = TRUE)
plot(sar_map["surface_sar"], border = FALSE, logz = TRUE)
}