% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/metadata.R
\name{ck_catalogue}
\alias{ck_catalogue}
\title{climatekit Index Catalogue}
\usage{
ck_catalogue()
}
\value{
A data frame with columns \code{ck_function}, \code{code}, \code{name},
\code{category}, \code{sector}, \code{unit}, \code{standard}, and \code{citation_key}.
}
\description{
Returns the complete catalogue of climate indices implemented by
\code{climatekit}, with one row per \verb{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.
}
\details{
Use \code{\link[=ck_browse]{ck_browse()}} to filter by sector or standard.
}
\examples{
tab <- ck_catalogue()
head(tab)
# Tally indices by standard:
table(tab$standard)
}
