CSIndicators (version 1.1.2)

SelectPeriodOnDates: Select a period on Dates

Description

Auxiliary function to subset dates for a specific period.

Usage

SelectPeriodOnDates(dates, start, end, time_dim = "time", ncores = NULL)

Value

A multidimensional array with named dimensions containing the subset of the vector dates during the period requested from start to end.

Arguments

dates

An array of dates with named dimensions.

start

An optional 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

An optional 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

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(Dates) <- c(time = 214, sdate = 3)
Period <- SelectPeriodOnDates(Dates, start = list(21, 6), end = list(21, 9))