R/pg_list_sets.R

In ropensci/pangaear: Client for the 'Pangaea' Database

#' List the set structure of the Pangaea repository
#'
#' @export
#' @param token	(character) a token previously provided by the server to
#' resume a request where it last left off. 50 is max number of records
#' returned. We will loop for you internally to get all the records you
#' asked for.
#' @param as (character) What to return. One of "df" (for data.frame; default),
#' "list", or "raw" (raw text)
#' @param ... Curl debugging options passed on to [oai::list_sets()]
#' @return XML character string, data.frame, or list, depending on what
#' requested with the `as` parameter
#' @references [OAI-PMH documentation](https://www.openarchives.org/pmh/)
#' @seealso wraps [oai::list_sets()]
#' @family oai methods
#' @examples \dontrun{
#' pg_list_sets()
#' pg_list_sets(as = "list")
#' pg_list_sets(as = "raw")
#' }

pg_list_sets <- function(token = NULL, as = "df", ...) {
  oai::list_sets(url = baseoai(), token = token, as = as, ...)
}