R/rt_external_db.R

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

#' Retrieve external DBs referenced in TAXREF
#'
#' If the function is used without arguments returns the list of external
#' databases used in TAXREF.
#'
#' @param db_id {`NULL` or `character(1)` \[default = `NULL`\]}\cr{}
#'              The id of an external db referenced in TAXREF
#'
#' @examples
#' \dontrun{rt_external_db(db_id = "worms")}
#'
#' @export
rt_external_db = function(db_id = NULL) {

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

  api_query = rt_GET("externalDb/", tolower(db_id))

  parse_taxa(api_query)
}