Load Package-wide Constants into Local Environment
Description
Load Package-wide Constants into Local Environment
Usage
API_CONSTANTSAPI_CONSTANTS
Format
An object of class character of length 1.
Download Databrary Constants From API.
Description
Download Databrary Constants From API.
Usage
assign_constants(vb = options::opt("vb"), rq = NULL)assign_constants(vb = options::opt("vb"), rq = NULL)
Arguments
vb |
Show verbose messages. (Defaults to |
rq |
An |
Value
A data frame with the constants.
Examples
assign_constants()assign_constants()
Check SSL Certificates For nyu.databary.org.
Description
check_ssl_certs checks the SSL certificates for nyu.databrary.org
and returns a data frame with the relevant information.
Usage
check_ssl_certs(host = "nyu.databrary.org")check_ssl_certs(host = "nyu.databrary.org")
Arguments
host |
Target URL. Defaults to 'nyu.databrary.org'. |
Value
A data frame with information about the SSL certificates.
Examples
check_ssl_certs()check_ssl_certs()
Returns the Avatar(s) (images) for Authorized User(s).
Description
Returns the Avatar(s) (images) for Authorized User(s).
Usage
download_party_avatar( party_id = 6, show_party_info = TRUE, vb = options::opt("vb"), rq = NULL )download_party_avatar( party_id = 6, show_party_info = TRUE, vb = options::opt("vb"), rq = NULL )
Arguments
party_id |
A number or range of numbers. Party number or numbers to retrieve information about. Default is 6 (Rick Gilmore). |
show_party_info |
A logical value. Show the person's name and affiliation in the output. Default is TRUE. |
vb |
Show verbose messages. (Defaults to |
rq |
An |
Value
An list with the avatar (image) file and a name_affil string.
Examples
## Not run: download_party_avatar() # Show Rick Gilmore's (party 6) avatar. # Download avatars from Databrary's founders (without name/affiliations) download_party_avatar(5:7, show_party_info = FALSE) # Download NYU logo download_party_avatar(party = 8) ## End(Not run)## Not run: download_party_avatar() # Show Rick Gilmore's (party 6) avatar. # Download avatars from Databrary's founders (without name/affiliations) download_party_avatar(5:7, show_party_info = FALSE) # Download NYU logo download_party_avatar(party = 8) ## End(Not run)
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 = tempdir(), timeout_secs = REQUEST_TIMEOUT, vb = options::opt("vb"), rq = NULL )download_session_asset( asset_id = 1, session_id = 9807, file_name = NULL, target_dir = tempdir(), timeout_secs = REQUEST_TIMEOUT, vb = options::opt("vb"), 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 |
timeout_secs |
An integer constant. The default value, defined in CONSTANTS.R is REQUEST_TIMEOUT. This value determines the default timeout value for the httr2 request object. When downloading large files, it can be useful to set this value to a large number. |
vb |
Show verbose messages. (Defaults to |
rq |
A list in the form of an |
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)## 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)
Download Asset From A Databrary Session.
Description
Databrary stores file types (assets) of many types. This function downloads assets in a data frame generated by list_session_assets().
Usage
download_session_assets_fr_df( session_df = list_session_assets(), target_dir = tempdir(), add_session_subdir = TRUE, overwrite = TRUE, make_portable_fn = FALSE, timeout_secs = REQUEST_TIMEOUT_VERY_LONG, vb = options::opt("vb"), rq = NULL )download_session_assets_fr_df( session_df = list_session_assets(), target_dir = tempdir(), add_session_subdir = TRUE, overwrite = TRUE, make_portable_fn = FALSE, timeout_secs = REQUEST_TIMEOUT_VERY_LONG, vb = options::opt("vb"), rq = NULL )
Arguments
session_df |
A data frame as generated by list_session_assets_2(). |
target_dir |
A character string. Directory to save the downloaded file. Default is directory named after the session_id. |
add_session_subdir |
A logical value. Add add the session name to the file path so that files are in a subdirectory specific to the session. Default is TRUE. |
overwrite |
A logical value. Overwrite an existing file. Default is TRUE. |
make_portable_fn |
A logical value. Replace characters in file names that are not broadly portable across file systems. Default is FALSE. |
timeout_secs |
An integer. The seconds an httr2 request will run before timing out. Default is 600 (10 min). This is to handle very large files. |
vb |
Show verbose messages. (Defaults to |
rq |
A list in the form of an |
Value
Full file names to the downloaded assets or NULL.
Examples
## Not run: download_session_assets_fr_df() # Downloads all of the files from session 9807 in Databrary volume 1. # Just the CSVs v1 <- list_session_assets() v1_csv <- dplyr::filter(v1, format_extension == "csv") download_session_assets_fr_df(v1_csv, vb = TRUE) ## End(Not run)## Not run: download_session_assets_fr_df() # Downloads all of the files from session 9807 in Databrary volume 1. # Just the CSVs v1 <- list_session_assets() v1_csv <- dplyr::filter(v1, format_extension == "csv") download_session_assets_fr_df(v1_csv, vb = TRUE) ## End(Not run)
Download Session Spreadsheet As CSV
Description
Databrary generates a CSV-formated spreadsheet that summarizes information about individual sessions. This command downloads that CSV file as a temporary file or with a name specified by the user.
Usage
download_session_csv( vol_id = 1, file_name = "test.csv", target_dir = tempdir(), as_df = FALSE, vb = options::opt("vb"), rq = NULL )download_session_csv( vol_id = 1, file_name = "test.csv", target_dir = tempdir(), as_df = FALSE, vb = options::opt("vb"), rq = NULL )
Arguments
vol_id |
An integer. Target volume number. Default is 1. |
file_name |
A character string. Name for the output file. Default is 'test.csv'. |
target_dir |
A character string. Directory to save downloaded file.
Default is |
as_df |
A logical value. Convert the data from a list to a data frame. Default is FALSE. |
vb |
Show verbose messages. (Defaults to |
rq |
An |
Value
A character string that is the name of the downloaded file or a
data frame if as_df is TRUE.
Examples
## Not run: download_session_csv() # Downloads "session" CSV for volume 1 ## End(Not run)## Not run: download_session_csv() # Downloads "session" CSV for volume 1 ## End(Not run)
Download Zip Archive From Databrary Session.
Description
Download Zip Archive From Databrary Session.
Usage
download_session_zip( vol_id = 31, session_id = 9803, out_dir = tempdir(), file_name = "test.zip", vb = options::opt("vb"), rq = NULL )download_session_zip( vol_id = 31, session_id = 9803, out_dir = tempdir(), file_name = "test.zip", vb = options::opt("vb"), rq = NULL )
Arguments
vol_id |
Volume number. |
session_id |
Slot/session number. |
out_dir |
Directory to save output file. |
file_name |
Name for downloaded file, default is 'test.zip'. |
vb |
Show verbose messages. (Defaults to |
rq |
An |
Value
Full filename of the downloaded file.
Examples
## Not run: download_session_zip() # Downloads Zip Archive from volume 31, session 9803 ## End(Not run)## Not run: download_session_zip() # Downloads Zip Archive from volume 31, session 9803 ## End(Not run)
Download Single 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). It is designed to work with download_session_assets_fr_df() so that multiple files can be downloaded simultaneously.
Usage
download_single_session_asset_fr_df( i = NULL, session_df = NULL, target_dir = tempdir(), add_session_subdir = TRUE, overwrite = TRUE, make_portable_fn = FALSE, timeout_secs = REQUEST_TIMEOUT_VERY_LONG, vb = options::opt("vb"), rq = NULL )download_single_session_asset_fr_df( i = NULL, session_df = NULL, target_dir = tempdir(), add_session_subdir = TRUE, overwrite = TRUE, make_portable_fn = FALSE, timeout_secs = REQUEST_TIMEOUT_VERY_LONG, vb = options::opt("vb"), rq = NULL )
Arguments
i |
An integer. Index into a row of the session asset data frame. Default is NULL. |
session_df |
A row from a data frame from |
target_dir |
A character string. Directory to save the downloaded file.
Default is a temporary directory given by a call to |
add_session_subdir |
A logical value. Add add the session name to the file path so that files are in a subdirectory specific to the session. Default is TRUE. |
overwrite |
A logical value. Overwrite an existing file. Default is TRUE. |
make_portable_fn |
A logical value. Replace characters in file names that are not broadly portable across file systems. Default is FALSE. |
timeout_secs |
An integer. The seconds an httr2 request will run before timing out. Default is 600 (10 min). This is to handle very large files. |
vb |
Show verbose messages. (Defaults to |
rq |
A list in the form of an |
Value
Full file name to the asset or NULL.
Examples
## Not run: vol_1 <- list_session_assets(session_id = 9807) a_1 <- vol_1[1,] tmp_dir <- tempdir() fn <- file.path(tmp_dir, paste0(a_1$asset_name, ".", a_1$format_extension)) download_single_session_asset_fr_df(a_1$asset_id, fn, session_id = a_1$session_id, vb = TRUE) ## End(Not run)## Not run: vol_1 <- list_session_assets(session_id = 9807) a_1 <- vol_1[1,] tmp_dir <- tempdir() fn <- file.path(tmp_dir, paste0(a_1$asset_name, ".", a_1$format_extension)) download_single_session_asset_fr_df(a_1$asset_id, fn, session_id = a_1$session_id, vb = TRUE) ## End(Not run)
Download Video From Databrary.
Description
Download Video From Databrary.
Usage
download_video( asset_id = 1, session_id = 9807, file_name = tempfile(paste0(session_id, "_", asset_id, "_"), fileext = ".mp4"), target_dir = tempdir(), vb = options::opt("vb"), rq = NULL )download_video( asset_id = 1, session_id = 9807, file_name = tempfile(paste0(session_id, "_", asset_id, "_"), fileext = ".mp4"), target_dir = tempdir(), vb = options::opt("vb"), rq = NULL )
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 |
vb |
Show verbose messages. (Defaults to |
rq |
An |
Value
Full file name to the asset.
Examples
## Not run: download_video() # Download's 'numbers' file from volume 1. download_video(asset_id = 11643, session_id = 9825, file_name = "rdk.mp4") #' # Downloads a display with a random dot kinematogram (RDK). ## End(Not run)## Not run: download_video() # Download's 'numbers' file from volume 1. download_video(asset_id = 11643, session_id = 9825, file_name = "rdk.mp4") #' # Downloads a display with a random dot kinematogram (RDK). ## End(Not run)
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 = options::opt("vb"), rq = NULL )download_volume_zip( vol_id = 31, out_dir = tempdir(), file_name = "test.zip", vb = options::opt("vb"), 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 |
Show verbose messages. (Defaults to |
rq |
An |
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)## Not run: download_volume_zip() # Zip file of all data from volume 31, the default. ## End(Not run)
Get Time Range For An Asset.
Description
Get Time Range For An Asset.
Usage
get_asset_segment_range( vol_id = 1, session_id = 9807, asset_id = 1, convert_JSON = TRUE, segment_only = TRUE, vb = options::opt("vb"), rq = NULL )get_asset_segment_range( vol_id = 1, session_id = 9807, asset_id = 1, convert_JSON = TRUE, segment_only = TRUE, vb = options::opt("vb"), rq = NULL )
Arguments
vol_id |
Volume ID |
session_id |
Slot/session number. |
asset_id |
Asset number. |
convert_JSON |
A Boolean value. If TRUE, convert JSON to a data frame. Default is TRUE. |
segment_only |
A Boolean value. If TRUE, returns only the segment values. Otherwise returns a data frame with two fields, segment and permission. Default is TRUE. |
vb |
Show verbose messages. (Defaults to |
rq |
An |
Value
The time range (in ms) for an asset, if one is indicated.
Examples
get_asset_segment_range()get_asset_segment_range()
Helper function for list_volume_assets
Description
Helper function for list_volume_assets
Usage
get_assets_from_session(volume_container, ignore_materials = TRUE)get_assets_from_session(volume_container, ignore_materials = TRUE)
Arguments
volume_container |
The 'container' list from a volume. |
ignore_materials |
A logical value. |
Get Stats About Databrary.
Description
get_db_stats returns basic summary information about
the institutions, people, and data hosted on 'Databrary.org'.
Usage
get_db_stats(type = "stats", vb = options::opt("vb"), rq = NULL)get_db_stats(type = "stats", vb = options::opt("vb"), rq = NULL)
Arguments
type |
Type of Databrary report to run "institutions", "people", "data" |
vb |
Show verbose messages. (Defaults to |
rq |
An |
Value
A data frame with the requested data or NULL if there is no new information.
Examples
get_db_stats() get_db_stats("stats") get_db_stats("people") # Information about the newest authorized investigators. get_db_stats("places") # Information about the newest institutions.get_db_stats() get_db_stats("stats") get_db_stats("people") # Information about the newest authorized investigators. get_db_stats("places") # Information about the newest institutions.
Get Duration (In ms) Of A File.
Description
Get Duration (In ms) Of A File.
Usage
get_file_duration( asset_id = 1, types_w_durations = c("-600", "-800"), vb = options::opt("vb"), rq = NULL )get_file_duration( asset_id = 1, types_w_durations = c("-600", "-800"), vb = options::opt("vb"), rq = NULL )
Arguments
asset_id |
Asset number. |
types_w_durations |
Asset types that have valid durations. |
vb |
Show verbose messages. (Defaults to |
rq |
An |
Value
Duration of a file in ms.
Examples
get_file_duration() # default is the test video from databrary.org/volume/1get_file_duration() # default is the test video from databrary.org/volume/1
List Sessions Info in Databrary Volume Container
Description
List Sessions Info in Databrary Volume Container
Usage
get_info_from_session( volume_container, ignore_materials = FALSE, release_levels )get_info_from_session( volume_container, ignore_materials = FALSE, release_levels )
Arguments
volume_container |
A component of a volume list returned by get_volume_by_id(). |
ignore_materials |
A logical value specifying whether to ignore "materials" folders. Default is TRUE |
release_levels |
A data frame mapping release level indices to release level text values. |
Download Information About a Party on Databrary as JSON
Description
Download Information About a Party on Databrary as JSON
Usage
get_party_by_id( party_id = 6, parents_children_access = TRUE, vb = options::opt("vb"), rq = NULL )get_party_by_id( party_id = 6, parents_children_access = TRUE, vb = options::opt("vb"), rq = NULL )
Arguments
party_id |
An integer. The party number to retrieve information about. |
parents_children_access |
A logical value. If TRUE (the default), returns all of the data about the party. If FALSE, only a minimum amount of information about the party is returned. |
vb |
Show verbose messages. (Defaults to |
rq |
An |
Value
A nested list with information about the party. This can be readily parsed by other functions.
Examples
## Not run: get_party_by_id() ## End(Not run)## Not run: get_party_by_id() ## End(Not run)
Extract Databrary Permission Levels.
Description
Extract Databrary Permission Levels.
Usage
get_permission_levels(vb = options::opt("vb"))get_permission_levels(vb = options::opt("vb"))
Arguments
vb |
Show verbose messages. (Defaults to |
Value
An array with the permission levels that can be assigned to data.
Examples
get_permission_levels()get_permission_levels()
Show Databrary Release Levels
Description
Show Databrary Release Levels
Usage
get_release_levels(vb = options::opt("vb"))get_release_levels(vb = options::opt("vb"))
Arguments
vb |
Show verbose messages. (Defaults to |
Value
A data frame with Databrary's release levels.
Examples
get_release_levels()get_release_levels()
Get Session (Slot) Data From A Databrary Volume
Description
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 )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 |
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
## Not run: get_session_by_id() # Default is Volume 1, Session 9807, the Materials folder ## End(Not run)## Not run: get_session_by_id() # Default is Volume 1, Session 9807, the Materials folder ## End(Not run)
Get Session (Slot) Data From A Databrary Volume By Session Name.
Description
Get Session (Slot) Data From A Databrary Volume By Session Name.
Usage
get_session_by_name( session_name = "Advisory Board Meeting", vol_id = 1, vb = options::opt("vb"), rq = NULL )get_session_by_name( session_name = "Advisory Board Meeting", vol_id = 1, vb = options::opt("vb"), rq = NULL )
Arguments
session_name |
A string. The name of the target session. Defaults to "Advisory Board Meeting", the name of several of the sessions in the public Volume 1. |
vol_id |
An integer indicating the volume identifier. Default is 1. |
vb |
Show verbose messages. (Defaults to |
rq |
An httr2 request, such as that generated by |
Value
One or more JSON blobs (as lists) whose session name(s) match
name in the given volume.
Examples
## Not run: # Returns multiple JSON blobs with the name "Advisory Board Meeting" in Volume 1. get_session_by_name() get_session_by_name(name = 'Top-level materials') ## End(Not run)## Not run: # Returns multiple JSON blobs with the name "Advisory Board Meeting" in Volume 1. get_session_by_name() get_session_by_name(name = 'Top-level materials') ## End(Not run)
Extracts File Types Supported by Databrary.
Description
Extracts File Types Supported by Databrary.
Usage
get_supported_file_types(vb = options::opt("vb"))get_supported_file_types(vb = options::opt("vb"))
Arguments
vb |
Show verbose messages. (Defaults to |
Value
A data frame with the file types permitted on Databrary.
Examples
get_supported_file_types()get_supported_file_types()
Get Summary Data About A Databrary Volume
Description
Get Summary Data About A Databrary Volume
Usage
get_volume_by_id(vol_id = 1, vb = options::opt("vb"), rq = NULL)get_volume_by_id(vol_id = 1, vb = options::opt("vb"), rq = NULL)
Arguments
vol_id |
Volume ID. |
vb |
Show verbose messages. (Defaults to |
rq |
An |
Value
A tibble with summary information about a volume.
Examples
get_volume_by_id() # Default is Volume 1get_volume_by_id() # Default is Volume 1
Convert Timestamp String To ms.
Description
Convert Timestamp String To ms.
Usage
HHMMSSmmm_to_ms(HHMMSSmmm = "01:01:01:333")HHMMSSmmm_to_ms(HHMMSSmmm = "01:01:01:333")
Arguments
HHMMSSmmm |
a string in the format "HH:MM:SS:mmm" |
Value
A numeric value in ms from the input string.
Examples
HHMMSSmmm_to_ms() # 01:01:01:333 in msHHMMSSmmm_to_ms() # 01:01:01:333 in ms
Is This Party An Institution?
Description
Is This Party An Institution?
Usage
is_institution(party_id = 8, vb = options::opt("vb"), rq = NULL)is_institution(party_id = 8, vb = options::opt("vb"), rq = NULL)
Arguments
party_id |
Databrary party ID |
vb |
Show verbose messages. (Defaults to |
rq |
An |
Value
TRUE if the party is an institution, FALSE otherwise.
Examples
is_institution() # Is party 8 (NYU) an institution.is_institution() # Is party 8 (NYU) an institution.
Is This Party A Person?
Description
Is This Party A Person?
Usage
is_person(party_id = 7, vb = options::opt("vb"), rq = NULL)is_person(party_id = 7, vb = options::opt("vb"), rq = NULL)
Arguments
party_id |
Databrary party ID |
vb |
Show verbose messages. (Defaults to |
rq |
An |
Value
TRUE if the party is a person, FALSE otherwise.
Examples
is_person()is_person()
List Stored Assets (Files) By Type.
Description
List Stored Assets (Files) By Type.
Usage
list_asset_formats(vb = options::opt("vb"))list_asset_formats(vb = options::opt("vb"))
Arguments
vb |
Show verbose messages. (Defaults to |
Value
A data frame with information about the data formats Databrary supports.
Examples
list_asset_formats()list_asset_formats()
List Authorized Investigators at Institution
Description
List Authorized Investigators at Institution
Usage
list_authorized_investigators( party_id = 12, vb = options::opt("vb"), rq = NULL )list_authorized_investigators( party_id = 12, vb = options::opt("vb"), rq = NULL )
Arguments
party_id |
Target party ID. |
vb |
Show verbose messages. (Defaults to |
rq |
An |
Value
A data frame with information the institution's authorized investigators.
Examples
## Not run: list_institutional_affiliates() # Default is Penn State (party 12) ## End(Not run)## Not run: list_institutional_affiliates() # Default is Penn State (party 12) ## End(Not run)
List Affiliates For A Party
Description
List Affiliates For A Party
Usage
list_party_affiliates(party_id = 6, vb = options::opt("vb"), rq = NULL)list_party_affiliates(party_id = 6, vb = options::opt("vb"), rq = NULL)
Arguments
party_id |
Target party ID. |
vb |
Show verbose messages. (Defaults to |
rq |
An |
Value
A data frame with information about a party's affiliates.
Examples
list_party_affiliates() # Default is Rick Gilmore (party 6)list_party_affiliates() # Default is Rick Gilmore (party 6)
List Sponsors For A Party
Description
List Sponsors For A Party
Usage
list_party_sponsors(party_id = 6, vb = options::opt("vb"), rq = NULL)list_party_sponsors(party_id = 6, vb = options::opt("vb"), rq = NULL)
Arguments
party_id |
Target party ID. |
vb |
Show verbose messages. (Defaults to |
rq |
An |
Value
A data frame with information about a party's sponsors.
Examples
## Not run: list_party_sponsors() # Default is Rick Gilmore (party 6) ## End(Not run)## Not run: list_party_sponsors() # Default is Rick Gilmore (party 6) ## End(Not run)
List Volumes A Party Has Access To
Description
List Volumes A Party Has Access To
Usage
list_party_volumes(party_id = 6, vb = options::opt("vb"), rq = NULL)list_party_volumes(party_id = 6, vb = options::opt("vb"), rq = NULL)
Arguments
party_id |
Target party ID. |
vb |
Show verbose messages. (Defaults to |
rq |
An |
Value
A data frame with information about a party's sponsors.
Examples
## Not run: list_party_volumes() # Default is Rick Gilmore (party 6) ## End(Not run)## Not run: list_party_volumes() # Default is Rick Gilmore (party 6) ## End(Not run)
List Activity History in Databrary Session.
Description
If a user has access to a volume and session, this function returns the history of modifications to that session.
Usage
list_session_activity(session_id = 6256, vb = options::opt("vb"), rq = NULL)list_session_activity(session_id = 6256, vb = options::opt("vb"), rq = NULL)
Arguments
session_id |
Selected session/slot number. |
vb |
Show verbose messages. (Defaults to |
rq |
An |
Value
A list with the activity history on a session/slot.
Examples
## Not run: # The following will only return output if the user has write privileges # on the session. list_session_activity(session_id = 6256, vb = FALSE) ## End(Not run)## Not run: # The following will only return output if the user has write privileges # on the session. list_session_activity(session_id = 6256, vb = FALSE) ## End(Not run)
List Assets in a Databrary Session.
Description
#' @description
![[Experimental]](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB3aWR0aD0iMTM4IiBoZWlnaHQ9IjIwIiByb2xlPSJpbWciIGFyaWEtbGFiZWw9ImxpZmVjeWNsZTogZXhwZXJpbWVudGFsIj4KICAgIDx0aXRsZT5saWZlY3ljbGU6IGV4cGVyaW1lbnRhbDwvdGl0bGU+CiAgICA8bGluZWFyR3JhZGllbnQgaWQ9InMiIHgyPSIwIiB5Mj0iMTAwJSI+CiAgICAgICAgPHN0b3Agb2Zmc2V0PSIwIiBzdG9wLWNvbG9yPSIjYmJiIiBzdG9wLW9wYWNpdHk9Ii4xIiAvPgogICAgICAgIDxzdG9wIG9mZnNldD0iMSIgc3RvcC1vcGFjaXR5PSIuMSIgLz4KICAgIDwvbGluZWFyR3JhZGllbnQ+CiAgICA8Y2xpcFBhdGggaWQ9InIiPgogICAgICAgIDxyZWN0IHdpZHRoPSIxMzgiIGhlaWdodD0iMjAiIHJ4PSIzIiBmaWxsPSIjZmZmIiAvPgogICAgPC9jbGlwUGF0aD4KICAgIDxnIGNsaXAtcGF0aD0idXJsKCNyKSI+CiAgICAgICAgPHJlY3Qgd2lkdGg9IjU1IiBoZWlnaHQ9IjIwIiBmaWxsPSIjNTU1IiAvPgogICAgICAgIDxyZWN0IHg9IjU1IiB3aWR0aD0iODMiIGhlaWdodD0iMjAiIGZpbGw9IiNmZTdkMzciIC8+CiAgICAgICAgPHJlY3Qgd2lkdGg9IjEzOCIgaGVpZ2h0PSIyMCIgZmlsbD0idXJsKCNzKSIgLz4KICAgIDwvZz4KICAgIDxnIGZpbGw9IiNmZmYiIHRleHQtYW5jaG9yPSJtaWRkbGUiIGZvbnQtZmFtaWx5PSJWZXJkYW5hLEdlbmV2YSxEZWphVnUgU2FucyxzYW5zLXNlcmlmIiB0ZXh0LXJlbmRlcmluZz0iZ2VvbWV0cmljUHJlY2lzaW9uIiBmb250LXNpemU9IjExMCI+CiAgICAgICAgPHRleHQgYXJpYS1oaWRkZW49InRydWUiIHg9IjI4NSIgeT0iMTUwIiBmaWxsPSIjMDEwMTAxIiBmaWxsLW9wYWNpdHk9Ii4zIiB0cmFuc2Zvcm09InNjYWxlKC4xKSIgdGV4dExlbmd0aD0iNDUwIj5saWZlY3ljbGU8L3RleHQ+CiAgICAgICAgPHRleHQgeD0iMjg1IiB5PSIxNDAiIHRyYW5zZm9ybT0ic2NhbGUoLjEpIiBmaWxsPSIjZmZmIiB0ZXh0TGVuZ3RoPSI0NTAiPmxpZmVjeWNsZTwvdGV4dD4KICAgICAgICA8dGV4dCBhcmlhLWhpZGRlbj0idHJ1ZSIgeD0iOTU1IiB5PSIxNTAiIGZpbGw9IiMwMTAxMDEiIGZpbGwtb3BhY2l0eT0iLjMiIHRyYW5zZm9ybT0ic2NhbGUoLjEpIiB0ZXh0TGVuZ3RoPSI3MzAiPmV4cGVyaW1lbnRhbDwvdGV4dD4KICAgICAgICA8dGV4dCB4PSI5NTUiIHk9IjE0MCIgdHJhbnNmb3JtPSJzY2FsZSguMSkiIGZpbGw9IiNmZmYiIHRleHRMZW5ndGg9IjczMCI+ZXhwZXJpbWVudGFsPC90ZXh0PgogICAgPC9nPgo8L3N2Zz4K)
Usage
list_session_assets(session_id = 9807, vb = options::opt("vb"), rq = NULL)list_session_assets(session_id = 9807, vb = options::opt("vb"), rq = NULL)
Arguments
session_id |
An integer. A Databrary session number. Default is 9807, the "materials" folder from Databrary volume 1. |
vb |
Show verbose messages. (Defaults to |
rq |
An |
Details
As of v0.6.3 list_session_assets() replaces an older function that is now
named list_volume_session_assets(). The older function requires both
a volume ID and a session ID. The new function requires only a session ID.
Value
A data frame with information about all assets in a volume.
Examples
## Not run: list_session_assets() # Session 9807 in volume 1 ## End(Not run)## Not run: list_session_assets() # Session 9807 in volume 1 ## End(Not run)
List Sponsors For A Party
Description
List Sponsors For A Party
Usage
list_sponsors(party_id = 6, vb = options::opt("vb"), rq = NULL)list_sponsors(party_id = 6, vb = options::opt("vb"), rq = NULL)
Arguments
party_id |
Target party ID. |
vb |
Show verbose messages. (Defaults to |
rq |
An |
Value
A data frame with information about a party's sponsors.
Examples
## Not run: list_sponsors() # Default is Rick Gilmore (party 6) ## End(Not run)## Not run: list_sponsors() # Default is Rick Gilmore (party 6) ## End(Not run)
List Activity In A Databrary Volume
Description
If a user has access to a volume, this command lists the modification history of the volume as a
Usage
list_volume_activity(vol_id = 1, vb = options::opt("vb"), rq = NULL)list_volume_activity(vol_id = 1, vb = options::opt("vb"), rq = NULL)
Arguments
vol_id |
Selected volume number. |
vb |
Show verbose messages. (Defaults to |
rq |
An |
Value
A list with the activity history on a volume.
Examples
## Not run: # The following will only return output if the user has write privileges # on the volume. list_volume_activity(vol_id = 1) # Activity on volume 1. ## End(Not run)## Not run: # The following will only return output if the user has write privileges # on the volume. list_volume_activity(vol_id = 1) # Activity on volume 1. ## End(Not run)
List Assets in Databrary Volume.
Description
List Assets in Databrary Volume.
Usage
list_volume_assets(vol_id = 1, vb = options::opt("vb"), rq = NULL)list_volume_assets(vol_id = 1, vb = options::opt("vb"), rq = NULL)
Arguments
vol_id |
Target volume number. Default is 1. |
vb |
Show verbose messages. (Defaults to |
rq |
An |
Value
A data frame with information about all assets in a volume.
Examples
## Not run: list_volume_assets() # Assets in volume 1 ## End(Not run)## Not run: list_volume_assets() # Assets in volume 1 ## End(Not run)
List Image or Video Excerpts On A Databrary Volume.
Description
List Image or Video Excerpts On A Databrary Volume.
Usage
list_volume_excerpts(vol_id = 1, vb = options::opt("vb"), rq = NULL)list_volume_excerpts(vol_id = 1, vb = options::opt("vb"), rq = NULL)
Arguments
vol_id |
Target volume number. |
vb |
Show verbose messages. (Defaults to |
rq |
An |
Value
A list with information about any available excerpts.
Examples
list_volume_excerpts()list_volume_excerpts()
Lists Funders Associated With a Databrary Volume.
Description
Lists Funders Associated With a Databrary Volume.
Usage
list_volume_funding( vol_id = 1, add_id = TRUE, vb = options::opt("vb"), rq = NULL )list_volume_funding( vol_id = 1, add_id = TRUE, vb = options::opt("vb"), rq = NULL )
Arguments
vol_id |
Target volume number. |
add_id |
A logical value. Include the volume ID in the output. Default is TRUE. |
vb |
Show verbose messages. (Defaults to |
rq |
An |
Value
A data frame with funder information for the volume.
Examples
## Not run: list_volume_funding() # Funding for volume 1 list_volume_funding(vol_id = c(1:10)) ## End(Not run)## Not run: list_volume_funding() # Funding for volume 1 list_volume_funding(vol_id = c(1:10)) ## End(Not run)
List Basic Volume Info.
Description
List Basic Volume Info.
Usage
list_volume_info(vol_id = 1, vb = options::opt("vb"), rq = NULL)list_volume_info(vol_id = 1, vb = options::opt("vb"), rq = NULL)
Arguments
vol_id |
Target volume number. |
vb |
Show verbose messages. (Defaults to |
rq |
An |
Value
A data frame with basic information about a volume.
Examples
## Not run: list_volume_info() # Sessions in Volume 1 ## End(Not run)## Not run: list_volume_info() # Sessions in Volume 1 ## End(Not run)
Retrieves URL Links From A Databrary Volume.
Description
Retrieves URL Links From A Databrary Volume.
Usage
list_volume_links(vol_id = 1, vb = options::opt("vb"), rq = NULL)list_volume_links(vol_id = 1, vb = options::opt("vb"), rq = NULL)
Arguments
vol_id |
Target volume number. |
vb |
Show verbose messages. (Defaults to |
rq |
An |
Value
A data frame with the requested data.
Examples
## Not run: list_volume_links() # Links from volume 1 ## End(Not run)## Not run: list_volume_links() # Links from volume 1 ## End(Not run)
List Owners of a Databrary Volume.
Description
List Owners of a Databrary Volume.
Usage
list_volume_owners(vol_id = 1, vb = options::opt("vb"), rq = NULL)list_volume_owners(vol_id = 1, vb = options::opt("vb"), rq = NULL)
Arguments
vol_id |
Selected volume number. Default is volume 1. |
vb |
Show verbose messages. (Defaults to |
rq |
An |
Value
A data frame with information about a volume's owner(s).
Examples
list_volume_owners() # Lists information about the owners of volume 1.list_volume_owners() # Lists information about the owners of volume 1.
List Assets in a Session from a Databrary volume.
Description
#' @description
Usage
list_volume_session_assets( vol_id = 1, session_id = 9807, vb = options::opt("vb"), rq = NULL )list_volume_session_assets( vol_id = 1, session_id = 9807, vb = options::opt("vb"), rq = NULL )
Arguments
vol_id |
Target volume number. |
session_id |
The session number in the selected volume. |
vb |
Show verbose messages. (Defaults to |
rq |
An |
Details
list_volume_session_assets() is a new name for the <v0.6.2 list_session_assets() as
function. There is a new list_session_assets() function that does not
requre the volume ID. The list_volume_session_assets() requires a volume
ID.
Value
A data frame with information about all assets in a volume.
Examples
## Not run: list_volume_session_assets() # Session 9807 in volume 1 ## End(Not run)## Not run: list_volume_session_assets() # Session 9807 in volume 1 ## End(Not run)
List Sessions in Databrary Volume.
Description
List Sessions in Databrary Volume.
Usage
list_volume_sessions( vol_id = 1, include_vol_data = FALSE, vb = options::opt("vb"), rq = NULL )list_volume_sessions( vol_id = 1, include_vol_data = FALSE, vb = options::opt("vb"), rq = NULL )
Arguments
vol_id |
Target volume number. |
include_vol_data |
A Boolean value. Include volume-level metadata or not. Default is FALSE. |
vb |
Show verbose messages. (Defaults to |
rq |
An |
Value
A data frame with information about all assets in a volume.
Examples
## Not run: list_volume_sessions() # Sessions in Volume 1 ## End(Not run)## Not run: list_volume_sessions() # Sessions in Volume 1 ## End(Not run)
Lists Keywords And Tags For A Volume.
Description
Lists Keywords And Tags For A Volume.
Usage
list_volume_tags(vol_id = 1, vb = options::opt("vb"), rq = NULL)list_volume_tags(vol_id = 1, vb = options::opt("vb"), rq = NULL)
Arguments
vol_id |
Target volume number. |
vb |
Show verbose messages. (Defaults to |
rq |
An |
Value
A data frame with the requested data.
Examples
list_volume_tags()list_volume_tags()
Log In To Databrary.org.
Description
Log In To Databrary.org.
Usage
login_db( email = NULL, password = NULL, store = FALSE, overwrite = FALSE, vb = options::opt("vb"), SERVICE = KEYRING_SERVICE, rq = NULL )login_db( email = NULL, password = NULL, store = FALSE, overwrite = FALSE, vb = options::opt("vb"), SERVICE = KEYRING_SERVICE, rq = NULL )
Arguments
email |
Databrary account email address. |
password |
Databrary password (not recommended as it will displayed as you type) |
store |
A boolean value. If TRUE store/retrieve credentials from the system keyring/keychain. |
overwrite |
A boolean value. If TRUE and store is TRUE, overwrite/ update stored credentials in keyring/keychain. |
vb |
Show verbose messages. (Defaults to |
SERVICE |
A character label for stored credentials in the keyring. Default is "databrary" |
rq |
An |
Value
Logical value indicating whether log in is successful or not.
Examples
login_db() # Queries user for email and password interactively. ## Not run: # The following shows how to use credentials that have been stored previously. login_db(email = "[email protected]", store = TRUE) ## End(Not run)login_db() # Queries user for email and password interactively. ## Not run: # The following shows how to use credentials that have been stored previously. login_db(email = "[email protected]", store = TRUE) ## End(Not run)
Log Out of Databrary.org.
Description
Log Out of Databrary.org.
Usage
logout_db(vb = options::opt("vb"), rq = NULL)logout_db(vb = options::opt("vb"), rq = NULL)
Arguments
vb |
Show verbose messages. (Defaults to |
rq |
An |
Value
TRUE if logging out succeeds, FALSE otherwise.
Examples
logout_db()logout_db()
Set default httr request parameters.
Description
make_default_request sets default parameters for httr requests.
Usage
make_default_request()make_default_request()
Value
An httr2 request object.
Examples
make_default_request()make_default_request()
Make Portable File Names
Description
Make Portable File Names
Usage
make_fn_portable( fn, vb = options::opt("vb"), replace_regex = "[ &\\!\\)\\(\\}\\{\\[\\]\\+\\=@#\\$%\\^\\*]", replacement_char = "_" )make_fn_portable( fn, vb = options::opt("vb"), replace_regex = "[ &\\!\\)\\(\\}\\{\\[\\]\\+\\=@#\\$%\\^\\*]", replacement_char = "_" )
Arguments
fn |
Databrary party ID |
vb |
Show verbose messages. (Defaults to |
replace_regex |
A character string. A regular expression to capture the "non-portable" characters in fn. |
replacement_char |
A character string. The character(s) that will replace the non-portable characters. |
Value
A "cleaned" portable file name
Log In To Databrary.org.
Description
Log In To Databrary.org.
Usage
make_login_client( email = NULL, password = NULL, store = FALSE, overwrite = FALSE, vb = options::opt("vb"), SERVICE = KEYRING_SERVICE, rq = NULL )make_login_client( email = NULL, password = NULL, store = FALSE, overwrite = FALSE, vb = options::opt("vb"), SERVICE = KEYRING_SERVICE, rq = NULL )
Arguments
email |
Databrary account email address. |
password |
Databrary password (not recommended as it will displayed as you type) |
store |
A boolean value. If TRUE store/retrieve credentials from the system keyring/keychain. |
overwrite |
A boolean value. If TRUE and store is TRUE, overwrite/ update stored credentials in keyring/keychain. |
vb |
Show verbose messages. (Defaults to |
SERVICE |
A character label for stored credentials in the keyring. Default is "databrary" |
rq |
An |
Value
Logical value indicating whether log in is successful or not.
Examples
make_login_client() # Queries user for email and password interactively. ## Not run: # The following shows how to use credentials that have been stored previously. make_login_client(email = "[email protected]", store = TRUE) ## End(Not run)make_login_client() # Queries user for email and password interactively. ## Not run: # The following shows how to use credentials that have been stored previously. make_login_client(email = "[email protected]", store = TRUE) ## End(Not run)
databraryr Options
Description
Internally used, package-specific options. All options will prioritize R options() values, and fall back to environment variables if undefined. If neither the option nor the environment variable is set, a default value is used.
Checking Option Values
Option values specific to databraryr can be
accessed by passing the package name to env.
options::opts(env = "databraryr") options::opt(x, default, env = "databraryr")
Options
- vb
-
Show verbose messages.
- default:
FALSE
- option:
-
databraryr.vb
- envvar:
-
R_DATABRARYR_VB (evaluated if possible, raw string otherwise)
See Also
options getOption Sys.setenv Sys.getenv
Report Information About A Funder.
Description
Report Information About A Funder.
Usage
search_for_funder( search_string = "national+science+foundation", vb = options::opt("vb"), rq = NULL )search_for_funder( search_string = "national+science+foundation", vb = options::opt("vb"), rq = NULL )
Arguments
search_string |
String to search. |
vb |
Show verbose messages. (Defaults to |
rq |
An |
Value
A data frame with information about the funder.
Examples
search_for_funder("national+science+foundation")search_for_funder("national+science+foundation")
Search For Keywords in Databrary Volumes.
Description
Search For Keywords in Databrary Volumes.
Usage
search_for_keywords( search_string = "locomotion", vb = options::opt("vb"), rq = NULL )search_for_keywords( search_string = "locomotion", vb = options::opt("vb"), rq = NULL )
Arguments
search_string |
String to search. |
vb |
Show verbose messages. (Defaults to |
rq |
An |
Value
A list with the volumes that contain the keyword.
Examples
## Not run: search_for_keywords() # searches for volumes with "locomotion" as a keyword. search_for_keywords() # searches for volumes with "adult" as a keyword. search_for_keywords("adult") ## End(Not run)## Not run: search_for_keywords() # searches for volumes with "locomotion" as a keyword. search_for_keywords() # searches for volumes with "adult" as a keyword. search_for_keywords("adult") ## End(Not run)
Search For Tags on Volumes or Sessions.
Description
Search For Tags on Volumes or Sessions.
Usage
search_for_tags(search_string = "ICIS", vb = options::opt("vb"), rq = NULL)search_for_tags(search_string = "ICIS", vb = options::opt("vb"), rq = NULL)
Arguments
search_string |
String to search. |
vb |
Show verbose messages. (Defaults to |
rq |
An |
Value
An array of tags that match the tag_string.
Examples
## Not run: search_for_tags() # Searches for volumes that have the tag "ICIS" ## End(Not run)## Not run: search_for_tags() # Searches for volumes that have the tag "ICIS" ## End(Not run)