wizaRdry (version 0.2.6)

redcap: Fetch data from REDCap to be stored in a data frame

Description

Retrieves data from a REDCap instrument and ensures subject identifiers are propagated across all events

Usage

redcap(
  instrument_name = NULL,
  ...,
  raw_or_label = "raw",
  redcap_event_name = NULL,
  batch_size = 1000,
  records = NULL,
  fields = NULL,
  exclude_pii = TRUE,
  interview_date = NULL,
  date_format = "ymd",
  complete = NULL
)

Value

A data frame containing the requested REDCap data

Arguments

instrument_name

Name of the REDCap instrument

...

Optional column names to filter for. Only rows with non-missing values in ALL specified columns will be returned. This is useful for filtering data to only include complete cases for specific variables of interest.

raw_or_label

Whether to return raw or labeled values

redcap_event_name

Optional event name filter

batch_size

Number of records to retrieve per batch

records

Optional vector of specific record IDs

fields

Optional vector of specific fields

exclude_pii

Default TRUE remove all fields marked as identifiable

interview_date

Optional; can be either: - A date string in various formats (ISO, US, etc.) to filter data up to that date - A boolean TRUE to return only rows with non-NA interview_date values

date_format

Default ymd define date format for interview_date

complete

Option boolean TRUE will return only forms marked as complete in REDCap

Examples

if (FALSE) {
# Get data from a specific instrument
data <- redcap("demographics")
}