get_NOAA {oceanexplorer}

Obtain NOAA World Ocean Atlas dataset

Description

Retrieves data from the NOAA World Ocean Atlas.

Usage

get_NOAA(var, spat_res, av_period, cache = FALSE)

url_parser(var, spat_res, av_period, cache = FALSE)

Arguments

var

The chemical or physical variable of interest (possible choices: "temperature", "phosphate", "nitrate", "silicate", "oxygen", "salinity", "density").

spat_res

Spatial resolution, either 1 or 5 degree grid-cells (numeric) .

av_period

Temporal resolution, either "annual", specific seasons (e.g. "winter"), or month (e.g. "August").

cache

Caching the extracted NOAA file in the package's extdata directory (default = FALSE). Size of individual files is around 12 Mb. Use list_NOAA() to list cached data resources.

Details

Functions to retrieve data from the NOAA World Ocean Atlas . Data is an 3D array (longitude, latitude, and depth) and is loaded as a stars object. Check NOAA_data for available variables, respective units and their citations. The function can automatically cache the extracted files (default: cache = FALSE). The cached file will then reside in the package's extdata directory.

Value

stars object or path.

See Also

Introduction to the stars package

Examples

# path to NOAA server or local data source
url_parser("oxygen", 1, "annual")

if (interactive()) {

# retrieve NOAA data
get_NOAA("oxygen", 1, "annual")

}