Subset records from a REDCap project — redcap_read_records • readepi

Subset records from a REDCap project

Usage

redcap_read_records(
  base_url,
  token,
  records,
  id_position = 1L,
  id_col_name = NULL
)

Arguments

base_url: the URI of the REDCap project
token: the user-specific string that serves as the password for a project
records: a vector or a comma-separated string of subset of subject IDs
id_position: the column position of the variable that unique identifies the subjects
id_col_name: the column name with the subject IDs

Value

a list of 2 elements of type data.frame that contain the project data with the records of interest and its associated metadata.

Examples

if (FALSE) {
  result <- redcap_read_records(
    base_url    = "https://bbmc.ouhsc.edu/redcap/api/",
    token       = "9A81268476645C4E5F03428B8AC3AA7B",
    records     = c("1", "2", "3"),
    id_position = 1L,
    id_col_name = NULL
  )
}