Get Metadata for a Climate Index

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")
#> $index
#> [1] "frost_days"
#> 
#> $category
#> [1] "temperature"
#> 
#> $unit
#> [1] "days"
#> 
#> $description
#> [1] "Count of days where Tmin < 0°C"
#> 
#> $reference
#> [1] "ETCCDI"
#>