get_volume_by_id {databraryr}

Get Data From A Databrary Volume

Description

Get Data From A Databrary Volume

Usage

get_volume_by_id(vol_id = 1, vb = options::opt("vb"), rq = NULL)

Arguments

vol_id

Volume ID.

vb

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

rq

An httr2 request object. If NULL (the default), a new request is generated using make_default_request(). To access restricted data, the user must login with a specific request object using login_db().

Value

A JSON blob with the volume data. If the user has previously logged in to Databrary via login_db(), then volume(s) that have restricted access can be downloaded, subject to the sharing release levels on those volume(s).

Examples

get_volume_by_id() # Default is Volume 1