CST_Threshold {CSIndicators}R Documentation

Absolute value of a relative threshold (percentile)

Description

Frequently, thresholds are defined by a percentile that may correspond to a different absolute value depending on the variable, gridpoint and also julian day (time). This function calculates the corresponding value of a percentile given a dataset.

Usage

CST_Threshold(
  data,
  threshold,
  start = NULL,
  end = NULL,
  time_dim = "ftime",
  memb_dim = "member",
  sdate_dim = "sdate",
  na.rm = FALSE,
  ncores = NULL
)

Arguments

data

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

threshold

a single scalar or vector indicating the relative threshold(s).

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 temporal dimension. By default, it is set to 'ftime'. More than one dimension name matching the dimensions provided in the object data$data can be specified. This dimension is required to subset the data in a requested period.

memb_dim

a character string indicating the name of the dimension in which the ensemble members are stored. When set it to NULL, threshold is computed for individual members.

sdate_dim

a character string indicating the name of the dimension in which the initialization dates are stored.

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 probabilites in the element data.

Examples

threshold <- 0.9
exp <- CSTools::lonlat_prec
exp_probs <- CST_Threshold(exp, threshold)
exp$data <- array(rnorm(5 * 3 * 214 * 2),
                   c(member = 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'))
exp_probs <- CST_Threshold(exp, threshold, start = list(21, 4), end = list(21, 6))

[Package CSIndicators version 0.0.1 Index]