Compute a Climate Index by Name — ck

A generic dispatcher that calls the appropriate ck_* function based on a string index name. Useful for programmatic workflows where the index is selected at runtime.

Usage

ck_compute(data, index, ...)

Arguments

data

A named list or data frame containing the required input vectors. Column names should match function argument names (e.g. tmin, tmax, precip, dates).

index

Character. Name of the index to compute (e.g. "frost_days"). Use ck_available() to see valid names.

Where ETCCDI and ET-SCI share an acronym, climatekit follows the meaning its own ck_* function carries: "cwd" is ET-SCI cold-wave duration (ck_cwd()), not ETCCDI consecutive wet days, and "cdd" is ETCCDI consecutive dry days (ck_dry_days()), not cooling degree days. The unambiguous aliases "consecutive_wet_days", "consecutive_dry_days" and "cold_wave_duration" are also accepted.

...

Additional arguments passed to the underlying function (e.g. period, threshold, base).

Value

A data frame as returned by the underlying ck_* function.

Examples

d <- data.frame(
  dates = as.Date("2024-01-01") + 0:9,
  tmin = c(-2, 3, -1, 5, -3, 0, 2, -4, 1, -1)
)
ck_compute(d, "frost_days")
#>       period value      index unit
#> 1 2024-01-01     5 frost_days days