ck_metadata: Get Metadata for a Climate Index

View source: R/metadata.R

ck_metadataR Documentation

Get Metadata for a Climate Index

Description

Returns metadata (unit, category, description, reference) for a named climate index.

Usage

ck_metadata(index)

Arguments

index

Character string. The index name (e.g. "frost_days"). Use ck_available() to see valid names.

Value

A list with elements index, category, unit, description, and reference.

Examples

ck_metadata("frost_days")

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