databraryr (version 0.6.6)

download_volume_zip: Download Zip Archive of All Data in a Volume.

Description

Download Zip Archive of All Data in a Volume.

Usage

download_volume_zip(
  vol_id = 31,
  out_dir = tempdir(),
  file_name = "test.zip",
  vb = options::opt("vb"),
  rq = NULL
)

Value

Full filename of the downloaded file.

Arguments

vol_id

Volume number.

out_dir

Directory to save output file.

file_name

Name for downloaded file, default is 'test.mp4'.

vb

Show verbose messages. (Defaults to FALSE, overwritable using option 'databraryr.vb' or environment variable 'R_DATABRARYR_VB')

rq

An httr2 request object. Default is NULL.

Examples

# \donttest{
if (FALSE) {
download_volume_zip() # Zip file of all data from volume 31, the default.
}
# }