valueIndex2D: VALUE spatial index calculation

View source: R/validation2D.R

valueIndex2DR Documentation

VALUE spatial index calculation

Description

(non-atomic) Function to compute spatial VALUE indices from series.

Usage

valueIndex2D(
  tsl,
  index.code,
  dates = NULL,
  parallel = FALSE,
  max.ncores = 16,
  ncores = NULL
)

Arguments

tsl

List of time series vectors.

index.code

A character index code to be computed.

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.

parallel

Use parallel computation.

max.ncores

Maximum number of cores for parallel computing.

ncores

Number of threads for parallel computation. Default to ncores - 1.

Value

index.code matrix

Author(s)

M. N. Legasa


SantanderMetGroup/VALUE documentation built on July 8, 2023, 7:03 a.m.