download_session_asset: Download Asset From Databrary.

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

Download Asset From Databrary.

Description

Databrary stores file types (assets) of many types. This function downloads an asset based on its system-unique integer identifer (asset_id) and system-unique session (slot) identifier (session_id).

Usage

download_session_asset(
  asset_id = 1,
  session_id = 9807,
  file_name = NULL,
  target_dir = paste0("./", session_id),
  vb = FALSE,
  rq = NULL
)

Arguments

asset_id	An integer. Asset id for target file. Default is 1.
session_id	An integer. Slot/session number where target file is stored. Default is 9807.
file_name	A character string. Name for downloaded file. Default is NULL.
target_dir	A character string. Directory to save the downloaded file. Default is a temporary directory given by a call to tempdir().
vb	A logical value. If TRUE provides verbose output. Default is FALSE.
rq	A list in the form of an httr2 request object. Default is NULL.

Value

Full file name to the asset or NULL.

Examples

## Not run: 
download_session_asset() # Download's 'numbers' file from volume 1.
download_session_asset(asset_id = 11643, session_id = 9825, file_name = "rdk.mp4")
# Downloads a display with a random dot kinematogram (RDK).

## End(Not run)

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