CST_TotalTimeExceedingThreshold {CSIndicators}R Documentation

Total Time of a variable Exceeding (not exceeding) a Threshold

Description

The Total Time of a variable exceeding (or not) a Threshold returns the total number of days (if the data provided is daily, or the corresponding units to the data frequency provided) that a variable is exceeding a threshold during a period. The threshold provided must be in the same units than the variable units, i.e. to use a percentile as a scalar, the function AbsToProbs or QThreshold may be needed (see examples). Providing maximum temperature daily data, the following agriculture indices for heat stress can be obtained by using this function:

Usage

CST_TotalTimeExceedingThreshold(
  data,
  threshold,
  op = ">",
  start = NULL,
  end = NULL,
  time_dim = "ftime",
  na.rm = FALSE,
  ncores = NULL
)

Arguments

data

a 's2dv_cube' object as provided by function CST_Load in package CSTools.

threshold

a 's2dv_cube' object as output of a 'CST_' function in the same units as parameter data and with the common dimensions of the element data of the same length (e.g. an array with the same lengths of longitude and latitude). A single scalar is also possible (for the case of comparing all grid points with the same scalar).

op

a opartor '>' (by default), '<', '>=' or '<='.

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

exp <- CSTools::lonlat_data$exp
exp$data <- CSTools::lonlat_data$exp$data[1, 1, 3, 3, 1, 1]
DOT <- CST_TotalTimeExceedingThreshold(exp, threshold = 280)

[Package CSIndicators version 0.0.1 Index]