R/rt_status_type.R

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

#' Retrieve Status Types Used in TAXREF
#'
#' If the function is provided without arguments returns the entire list of
#' status types used in TAXREF.
#' @param status_id {`NULL` or `character(1)` \[default = `NULL`\]}\cr{}
#'                  A character identifying the type of status
#'
#' @export
rt_status_type = function(status_id = NULL) {

  stopifnot("'status_id' must be character or NULL" =
              is.character(status_id) | is.null(status_id))

  status_id = gsub("^EXPNA$", "exPNA", toupper(status_id))

  api_query = rt_GET("status/types/", status_id)

  parse_taxa(api_query)
}