R/rt_biogeo_status.R

In Rekyt/rtaxref: An R client for TaxRef the French Taxonomical Database

#' Retrieve biogeographic statuses used in TAXREF
#'
#' If the function is used without arguments returns the list of biogeographic
#' statuses used in TAXREF
#'
#' @param biogeo_id {`NULL` or `character(1)` \[default = `NULL`\]}\cr{}
#'                  A biogeographic status id used in TAXREF
#'
#' @examples
#' \dontrun{rt_biogeo_status(biogeo_id = "P")}
#'
#' @export
rt_biogeo_status = function(biogeo_id = NULL) {

  stopifnot(
    "'biogeo_id' must be NULL or a single character" =
      (is.character(biogeo_id) & isTRUE(nchar(biogeo_id) == 1)) |
      is.null(biogeo_id)
  )

  api_query = rt_GET("biogeographicStatus/", toupper(biogeo_id))

  parse_taxa(api_query)
}