is_region_series: Check the object is a valid region series

In EvolEcolGroup/pastclim: Manipulate Time Series of Palaeoclimate Reconstructions

Check the object is a valid region series

Description

A region series is a terra::SpatRasterDataset for which each sub-dataset is a variable, and all variables have the same number of time steps.

Usage

is_region_series(x, strict = FALSE)

Arguments

x	a terra::SpatRasterDataset representing a time series of regional reconstructions obtained from region_series().
strict	a boolean defining whether to preform a thorough test (see description above for details).

Details

The standard test only checks that all sub-datasets (each of which is a terra::SpatRaster) have the same number of layers. The more thorough test (obtained with strict=TRUE) actually checks that all variables have the same identical time steps by comparing the result of terra::time() applied to each variable.

Value

TRUE if the object is a region series

EvolEcolGroup/pastclim documentation built on Nov. 8, 2024, 5:21 a.m.