values: Specify dimension selectors with actual values

View source: R/values.R

valuesR Documentation

Specify dimension selectors with actual values

Description

This is a helper function used in a Start() call to define the desired range of dimensions. It specifies the actual value to be matched with the coordinate variable. See details in the documentation of the parameter ... 'indices to take' of the function Start().

Usage

values(x)

Arguments

x

A numeric vector or a list with two nemerics to take all the element between the two specified values (both extremes inclusive).

Value

Same as input, but with additional attribute 'indices', 'values', and 'chunk'.

See Also

indices

Examples

# Used in Start():
 data_path <- system.file('extdata', package = 'startR')
 path_obs <- file.path(data_path, 'obs/monthly_mean/$var$/$var$_$sdate$.nc')
 sdates <- c('200011', '200012')
 data <- Start(dat = list(list(path = path_obs)),
               var = 'tos',
               sdate = sdates,
               time = 'all',
               latitude = values(seq(-80, 80, 20)),
               latitude_reorder = Sort(),
               longitude = values(list(10, 300)),
               longitude_reorder = CircularSort(0, 360),
               return_vars = list(latitude = 'dat', 
                                  longitude = 'dat', 
                                  time = 'sdate'),
               retrieve = FALSE)

startR documentation built on Sept. 12, 2023, 5:07 p.m.

Related to values in startR...