valueIndex: VALUE measure calculation for climate4R grids

In SantanderMetGroup/climate4R.value: A climate4R package binding the VALUE R package for model validation

VALUE measure calculation for climate4R grids

Description

VALUE measure calculation for climate4R grids

Usage

valueIndex(
  grid = NULL,
  index.code = NULL,
  return.NApercentage = TRUE,
  parallel = FALSE,
  max.ncores = 16,
  condition = NULL,
  threshold = NULL,
  which.wetdays = NULL,
  ncores = NULL
)

Arguments

grid	Grid (also station data) of observations
index.code	Character of the index code to be computed (use VALUE::show.indices).
return.NApercentage	Logical to also return or not a grid containing NA percentage information.
parallel	Logical. Should parallel execution be used?
max.ncores	Integer. Upper bound for user-defined number of cores.
condition	Inequality operator to be applied to the given "threshold". Only the days that satisfy the condition will be used for validation the model. "GT" = greater than the value of threshold, "GE" = greater or equal, "LT" = lower than, "LE" = lower or equal than.
threshold	Numeric value. Threshold used as reference for the condition. Default is NULL. If a threshold value is supplied with no specificaction of the argument condition. Then condition is set to "GE".
which.wetdays	A string, default to NULL. Infer the measure/index taking into account only the wet days of the temporal serie. In this case, set which.wetdays = "Independent".
ncores	Integer number of cores used in parallel computation. Self-selected number of cores is used when ncpus = NULL (the default), or when maxcores exceeds the default ncores value.

Value

A grid of the index or a list containing the grid of the index and the grid of NA percenatage

Author(s)

M. Iturbide

M. N. Legasa

Examples

library(transformeR)
require(climate4R.datasets)
data(EOBS_Iberia_tas)
y <- EOBS_Iberia_tas
m <- valueIndex(y, "mean")
str(m$Index)
str(m$NApercentage)

SantanderMetGroup/climate4R.value documentation built on July 8, 2023, 8:01 a.m.