R/listregions.R

In ropensci/seaaroundus: Sea Around Us API Wrapper

#' List available regions for a region type
#'
#' @export
#' @param region (character) region type
#' @param ... curl options passed on to [crul::HttpClient()]
#' @return a data frame with columns:
#'
#' - region title
#' - region ID
#'
#' @examples \dontrun{
#' listregions(region = "eez")
#' }
listregions <- function(region, ...) {
  data <- callapi(paste0("api/v1/", region, "/"), list(nospatial = "true"), ...)
  return(data)
}