CST_PeriodAccumulation: Period Accumulation on 's2dv_cube' objects

Description Usage Arguments Value Examples

View source: R/PeriodAccumulation.R

Description

Period Accumulation computes the sum (accumulation) of a given variable in a period. Providing precipitation data, two agriculture indices can be obtained by using this function:

Usage

1
2
3
4
5
6
7
8
CST_PeriodAccumulation(
  data,
  start = NULL,
  end = NULL,
  time_dim = "ftime",
  na.rm = FALSE,
  ncores = NULL
)

Arguments

data

an 's2dv_cube' object as provided function CST_Load in package CSTools.

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. By default it is set to NULL and the indicator is computed using all the data provided in data.

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. By default it is set to NULL and the indicator is computed using all the data provided in data.

time_dim

a character string indicating the name of the function to compute the indicator. By default, it is set to 'ftime'. More than one dimension name matching the dimensions provided in the object data$data can be specified.

na.rm

a logical value indicating whether to ignore NA values (TRUE) or not (FALSE).

ncores

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

Value

A 's2dv_cube' object containing the indicator in the element data.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
exp <- CSTools::lonlat_prec
TP <- CST_PeriodAccumulation(exp)
exp$data <- array(rnorm(5 * 3 * 214 * 2),
                   c(memb = 5, sdate = 3, ftime = 214, lon = 2)) 
exp$Dates[[1]] <- 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'))
SprR <- CST_PeriodAccumulation(exp, start = list(21, 4), end = list(21, 6))
dim(SprR$data)
head(SprR$Dates)
HarR <- CST_PeriodAccumulation(exp, start = list(21, 8), end = list(21, 10))
dim(HarR$data)
head(HarR$Dates)

CSIndicators documentation built on May 7, 2021, 9:07 a.m.