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

In PLAY-behaviorome/databraryapi: Interact with the 'Databrary.org' API

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 = FALSE,
  rq = NULL
)

Arguments

vol_id	Volume number.
out_dir	Directory to save output file.
file_name	Name for downloaded file, default is 'test.mp4'.
vb	A Boolean value. If TRUE provides verbose output.
rq	An httr2 request object. Default is NULL.

Value

Full filename of the downloaded file.

Examples

## Not run: 
download_volume_zip() # Zip file of all data from volume 31, the default.

## End(Not run)

PLAY-behaviorome/databraryapi documentation built on April 24, 2024, 4:20 a.m.