ck_browse: Browse the climatekit Index Catalogue

View source: R/metadata.R

ck_browseR Documentation

Browse the climatekit Index Catalogue

Description

Filter the comprehensive climatekit index catalogue (see ck_catalogue()) by sector, applicable standard (ETCCDI / ET-SCI / agroclimatic / comfort / drought / energy), or a free-text search across the function name, full name, and ETCCDI code.

Usage

ck_browse(sector = NULL, standard = NULL, search = NULL)

Arguments

sector

Character (length 1) or NULL. Filter to indices tagged with this sector. Common values: "agriculture", "health", "water", "energy". NULL (default) returns all rows.

standard

Character (length 1) or NULL. Filter to indices under this standard. Common values: "ETCCDI", "ET-SCI", "ETCCDI-approx", "agroclimatic", "comfort", "drought", "energy". NULL (default) returns all rows.

search

Character (length 1) or NULL. Free-text search; rows are kept where the term appears (case-insensitive) in the function name, the full name, or the ETCCDI code.

Value

The catalogue, filtered to matching rows. Same column structure as ck_catalogue().

Examples

ck_browse(standard = "ETCCDI")
ck_browse(sector = "agriculture")
ck_browse(search = "heat")

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