R/versions.R

In ropensci/rdryad: Access for Dryad Web Services

#' Get a dataset version by version ID
#' @export
#' @name versions
#' @param ids (numeric/integer) one or more version ids, required
#' @param ... Further args passed on to [crul::verb-GET]
#' @return a list of lists, each named by the input DOI
#' @details 
#' 
#' `dryad_versions()` and `dryad_versions_files()`
#' use async http requests, while `dryad_versions_download()`
#' does not use async
#' 
#' @examples \dontrun{
#' dryad_versions(ids = 18774)
#' dryad_versions_files(ids = 18774)
#' dryad_versions_download(ids = 18774)
#' }

#' @export
#' @rdname versions
dryad_versions <- function(ids, ...) {
  assert(ids, c("numeric", "integer"))
  og_ids <- ids
  urls <- file.path(dr_base_apiv2(), file.path("api/v2/versions", ids))
  tmp <- dGETasync(urls = urls, ...)
  parse_each(tmp, og_ids)
}

#' @export
#' @rdname versions
dryad_versions_files <- function(ids, ...) {
  assert(ids, c("numeric", "integer"))
  urls <- file.path(dr_base_apiv2(), sprintf("api/v2/versions/%s/files", ids))
  tmp <- dGETasync(urls = urls, ...)
  parse_each(tmp, ids)
}

#' @export
#' @rdname versions
dryad_versions_download <- function(ids, ...) {
  assert(ids, c("numeric", "integer"))
  paths <- sprintf("api/v2/versions/%s/download", ids)
  Map(function(x, y) each_download(x, y, ...), ids, paths)
}