download_asset: Download Asset From Databrary.

View source: R/download_asset.R

download_assetR Documentation

Download Asset From Databrary.

Description

[Superseded]

download_asset() has been superseded in favor of download_video() and the more general download_session_asset().

Usage

download_asset(
  asset_id = 1,
  session_id = 9807,
  file_name = "test.mp4",
  target_dir = tempdir(),
  return_response = FALSE,
  vb = FALSE
)

Arguments

asset_id

Asset id for target file.

session_id

Slot/session number where target file is stored.

file_name

Name for downloaded file.

target_dir

Directory to save the downloaded file. Default is a temporary directory given by a call to tempdir().

return_response

A Boolean value.

vb

A Boolean value. If TRUE provides verbose output.

Value

A string that is the full file name of the asset.

Examples


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



PLAY-behaviorome/databraryapi documentation built on April 29, 2024, 2:16 a.m.