R/darwin_core_terms.R

In corella: Prepare, Manipulate and Check Data to Comply with Darwin Core Standard

#' Dataset of supported Darwin Core terms
#'
#' @description
#' The Darwin Core Standard is maintained by Biodiversity Information Standards,
#' previously known as the Taxonomic Databases Working Group and known by the
#' acronym 'TDWG'. This `tibble` is the full list of supported terms,
#' current as of 2024-12-10.
#'
#' Users can use [occurrence_terms()] and [event_terms()] as convenience
#' functions to access these terms.
#' @name darwin_core_terms
#' @format
#' A `tibble` containing valid Darwin Core Standard terms (206 rows x 6 columns).
#' Column descriptions are as follows:
#' \describe{
#'   \item{class}{TDWG group that a term belongs to.}
#'   \item{term}{Column header names that can be used in Darwin Core}
#'   \item{url}{Stable url to information describing the term.}
#'   \item{definition}{Human-readable definition of the term.}
#'   \item{comments}{Further information from TDWG.}
#'   \item{examples}{Examples of how the field should be populated.}
#'   \item{set_functions}{Function in corella that supports Darwin Core term.}
#' }
#' @seealso [occurrence_terms()] and [event_terms()] to get terms for use in
#' [dplyr::select()]
#' @source Slightly modified version of a
#' [table supplied by TDWG](https://github.com/tdwg/dwc/blob/master/vocabulary/term_versions.csv).
"darwin_core_terms"