Skip to contents

Get Session (Slot) Data From A Databrary Volume

Source: R/get_session_by_id.R
get_session_by_id.Rd

Get Session (Slot) Data From A Databrary Volume

Usage

get_session_by_id(
  session_id = 9807,
  vol_id = 1,
  vb = options::opt("vb"),
  rq = NULL
)

Arguments

session_id

An integer indicating a valid session/slot identifier linked to a volume. Default value is 9807, the materials folder for volume 1.

vol_id

An integer indicating the volume identifier. Default is 1.

vb

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

rq

An httr2 request object.

Value

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

Examples

# \donttest{
if (FALSE) { # \dontrun{
get_session_by_id() # Default is Volume 1, Session 9807, the Materials folder
} # }
# }