sdmpredictors (version 0.2.15)

list_layers_paleo: List the paleo climate layers provided by one or more datasets

Description

list_layers_paleo returns information on the paleo climate layers of one or more datasets.

Usage

list_layers_paleo(datasets = c(), model_name = NA, epoch = NA,
  years_ago = NA, terrestrial = NA, marine = NA, freshwater = NA, monthly =
  TRUE, version = NULL)

Value

A dataframe with information on the supported paleo climate layers.

Arguments

datasets

character vector. Code of the datasets.

model_name

character vector. Paleo climate model name see the model_name column in the result.

epoch

character vector. Epoch for which you want the paleo layer, e.g. "mid-Holocene", "Last Glacial Maximum".

years_ago

integer. Years for which you want the paleo layer, e.g. 6000, 21000.

terrestrial

logical. When TRUE (default), then datasets that only have terrestrial data (seamasked) are returned.

marine

logical. When TRUE (default), then datasets that only have marine data (landmasked) are returned.

freshwater

logical. When TRUE, then datasets that only have freshwater data are returned.

monthly

logical. When FALSE, then no monthly layers are returned. All annual and monthly layers are returned by default.

version

numeric vector. When NULL then layers from all versions of datasets are returned (default) else layers are filtered by version number.

Details

By default it returns all layers from all datasets, when both marine and terrestrial are FALSE then only layers without land- nor seamasks are returned.

See Also

list_layers, list_layers_future, list_datasets, load_layers

Examples

# list the first 5 layers
list_layers_paleo()[1:5,]
# list layer codes for MARSPEC for the mid-Holocene
list_layers_paleo("MARSPEC", epoch = "mid-Holocene")$layer_code