valueIndexXD: VALUE atomic and spatial index calculation

View source: R/valueIndex.R

valueIndexXDR Documentation

VALUE atomic and spatial index calculation

Description

VALUE index calculation helper function

Usage

valueIndexXD(
  ts = NULL,
  dates = NULL,
  index.code = NULL,
  parallel = FALSE,
  max.ncores = 16,
  ncores = NULL
)

Arguments

ts

list containing time series for each gridpoint/station

dates

A character (or POSIXct) vector following the format “YYYY-MM-DD” (i.e., format = "%Y-%m-%d" as in strptime). Note that the dates are not required by all indices, so the default is NULL. The function will yield an error if dates are required but not supplied.

index.code

Characher of the index code to be computed (use VALUE::show.indices).

parallel

Use parallel computing?

max.ncores

Maximum number of cores to use

ncores

Number of cores to use for parallel computing. Default to ncores-1.

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


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