R/list_sets.R

Defines functions list_sets

Documented in list_sets

#' List sets
#'
#' @export
#' @template url_ddd
#' @template as
#' @param token (character) a token previously provided by the server to
#' resume a request where it last left off
#' @examples \dontrun{
#' # Get back a data.frame
#' list_sets()
#'
#' # Get back a list
#' list_sets(as = "list")
#'
#' # Get back raw text
#' list_sets(as = "raw")
#'
#' # curl options
#' library("httr")
#' list_sets(config = verbose())
#' }
list_sets <- function(url = "http://api.gbif.org/v1/oai-pmh/registry",
  token = NULL, as = "df", ...) {

  check_url(url)
  args <- sc(list(verb = "ListSets", resumptionToken = token))
  out <- while_oai(url, args, token, as, ...)
  oai_give(out, as)
}
ropensci/oai documentation built on Nov. 18, 2022, 5:33 p.m.