ck_catalogue: climatekit Index Catalogue

View source: R/metadata.R

ck_catalogueR Documentation

climatekit Index Catalogue

Description

Returns the complete catalogue of climate indices implemented by climatekit, with one row per ⁠ck_*⁠ function and columns covering the canonical short code (where applicable), the full name, the index family, the relevant sector, the unit, the source standard, and the principal citation key.

Usage

ck_catalogue()

Details

Use ck_browse() to filter by sector or standard.

Value

A data frame with columns ck_function, code, name, category, sector, unit, standard, and citation_key.

Examples

tab <- ck_catalogue()
head(tab)
# Tally indices by standard:
table(tab$standard)

climatekit documentation built on May 9, 2026, 5:08 p.m.