CST_AbsToProbs: Transform ensemble forecast into probabilities

Description Usage Arguments Value Examples

View source: R/AbsToProbs.R

Description

The Cumulative Distribution Function of a forecast is used to obtain the probabilities of each value in the ensemble. If multiple initializations (start dates) are provided, the function will create the Cumulative Distribution Function excluding the corresponding initialization.

Usage

1
2
3
4
5
6
7
8
9
CST_AbsToProbs(
  data,
  start = NULL,
  end = NULL,
  time_dim = "ftime",
  memb_dim = "member",
  sdate_dim = "sdate",
  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 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.

sdate_dim

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

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
exp <- CSTools::lonlat_prec
exp_probs <- CST_AbsToProbs(exp)
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_AbsToProbs(exp, start = list(21, 4), end = list(21, 6))

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