CSIndicators (version 1.1.2)

CST_SelectPeriodOnData: Select a period on Data on 's2dv_cube' objects

Description

Auxiliary function to subset data for a specific period.

Usage

CST_SelectPeriodOnData(data, start, end, time_dim = "time", ncores = NULL)

Value

A 's2dv_cube' object containing the subset of the object data$data during the period requested from start to end.

Arguments

data

An 's2dv_cube' object as provided function CST_Start or CST_Load in package CSTools.

start

A parameter to defined the initial date of the period to select from the data by providing a list of two elements: the initial date of the period and the initial month of the period.

end

A parameter to defined the final date of the period to select from the data by providing a list of two elements: the final day of the period and the final month of the period.

time_dim

A character string indicating the name of the dimension to compute select the dates. By default, it is set to 'time'. More than one dimension name matching the dimensions provided in the object data$data can be specified.

ncores

An integer indicating the number of cores to use in parallel computation.

Examples

exp <- NULL
exp$data <- array(rnorm(5 * 3 * 214 * 2),
                 c(memb = 5, sdate = 3, time = 214, lon = 2)) 
exp$attrs$Dates <- c(seq(as.Date("01-05-2000", format = "%d-%m-%Y"), 
                        as.Date("30-11-2000", format = "%d-%m-%Y"), by = 'day'),
                    seq(as.Date("01-05-2001", format = "%d-%m-%Y"), 
                        as.Date("30-11-2001", format = "%d-%m-%Y"), by = 'day'),
                    seq(as.Date("01-05-2002", format = "%d-%m-%Y"), 
                        as.Date("30-11-2002", format = "%d-%m-%Y"), by = 'day'))
dim(exp$attrs$Dates) <- c(time = 214, sdate = 3)
class(exp) <- 's2dv_cube'
Period <- CST_SelectPeriodOnData(exp, start = list(21, 6), end = list(21, 9))