R/ns_ecohier.R

In ropenscilabs/natserv: 'NatureServe' Interface

#' Get a summary of the upper level hierarchy for an Ecosystem record
#'
#' @export
#' @param uid (character) A NatureServe taxon id (The taxon’s Element Global
#' UID)
#' @template ns
#' @return A list with lots of elements
#' @details see https://explorer.natureserve.org/api-docs/#_taxon_data_model
#' for details on the response data
#' @examples \dontrun{
#' ns_ecohier("ELEMENT_GLOBAL.2.683060")
#' }
ns_ecohier <- function(uid, ...) {
  assert(uid, "character")
  stopifnot("`uid` must be length 1" = length(uid) == 1)
  res <- ns_GET(
    url = file.path(ns_base(), 'api/data/ecosystemHierarchy', uid),
    ...
  )
  jsonlite::fromJSON(res)
}