R/rt_taxo_ranks.R

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

#' Retrieve taxonomic ranks in TAXREF
#'
#' If the function is used without arguments returns the entire list of
#' taxonomic ranks used in TAXREF.
#'
#' @param taxo_id {`NULL` or `character(1)` \[default = `NULL`\]}\cr{}
#'                the id of a taxonomic rank in TAXREF.
#'
#' @examples
#' \dontrun{rt_taxo_ranks(taxo_id = "VAR")}
#'
#' @export
rt_taxo_ranks = function(taxo_id = NULL) {

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

  taxo_id = gsub("^DUMM$", "Dumm", toupper(taxo_id))

  api_query = rt_GET("taxonomicRanks/", taxo_id)

  parse_taxa(api_query)
}