R/dwc_terms.R

In delimtools: Helper Functions for Species Delimitation Analysis

#' Print Darwin Core Terms, Definitions and Examples as Bullet Lists
#'
#' @description
#' `dwc_terms()` checks a vector or list of terms and return definitions and examples for
#' each one of them.
#'
#' @param dwc a list of standard terms and definitions created using [get_dwc].
#' @param terms a vector or list of terms to check.
#'
#' @details
#' For each term in a vector or list, `dwc_terms` will return a bullet list containing
#' the term, followed by its definition and examples.
#'
#' @return
#' a bullet list.
#'
#' @author
#' Pedro S. Bittencourt, Rupert A. Collins.
#'
#' @examples
#' dwc <- get_dwc(type= "simple")
#' dwc_terms(dwc, c("genus", "scientificName"))
#'
#' @export
dwc_terms <- function(dwc, terms){

  dwc$terms |>
    dplyr::filter(.data$term_localName %in% {{ terms }}) |>
    dplyr::arrange(match(.data$term_localName, {{ terms }})) |>
    stringr::str_glue_data("{ term_localName }: { definition } Examples: { examples }", sep= " ") |>
    cli::cli_li()

}