databraryr (version 0.6.6)

get_session_by_name: 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
)

Value

One or more JSON blobs (as lists) whose session name(s) match name in the given volume.

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 FALSE, overwritable using option 'databraryr.vb' or environment variable 'R_DATABRARYR_VB')

rq

An httr2 request, such as that generated by make_default_request().

Examples

# \donttest{
if (FALSE) {
# 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')
}
# }