% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/metadata.R
\name{ck_etccdi_27}
\alias{ck_etccdi_27}
\title{Canonical ETCCDI 27 Indices}
\usage{
ck_etccdi_27()
}
\value{
A data frame with one row per canonical ETCCDI index and
columns \code{code}, \code{name}, \code{variable}, \code{unit}, \code{definition},
\code{ck_function}, and \code{status}.
}
\description{
Returns the 27 canonical Expert Team on Climate Change Detection and
Indices (ETCCDI) indices as documented by Alexander et al. (2006) and
Zhang et al. (2011), with each row showing the canonical short code,
full name, input variable, unit, definition, and the corresponding
\code{climatekit} function (or \code{NA} where the index is not yet
implemented).
}
\details{
Use this table to audit coverage, locate the \verb{ck_*} function for a
given ETCCDI code, or filter to indices that climatekit currently
implements: \code{subset(ck_etccdi_27(), !is.na(ck_function))}.
}
\examples{
tab <- ck_etccdi_27()
head(tab)
# Indices currently implemented in climatekit:
subset(tab, !is.na(ck_function))[, c("code", "ck_function")]
# Coverage:
table(tab$status)
}
\references{
Alexander, L. V. et al. (2006). Global observed changes in daily
climate extremes of temperature and precipitation. \emph{Journal of
Geophysical Research: Atmospheres}, 111(D5).
\doi{10.1029/2005JD006290}.

Zhang, X. et al. (2011). Indices for monitoring changes in extremes
based on daily temperature and precipitation data. \emph{Wiley
Interdisciplinary Reviews: Climate Change}, 2(6), 851-870.
\doi{10.1002/wcc.147}.
}
