- redcap_uri
The URI (uniform resource identifier) of the REDCap
project. Required.
- token
The user-specific string that serves as the password for a
project. Required.
- records
An array, where each element corresponds to the ID of a
desired record. Optional.
- records_collapsed
A single string, where the desired ID values
are separated by commas. Optional.
- fields
An array, where each element corresponds to a desired project
field. Optional.
- fields_collapsed
A single string, where the desired field names are
separated by commas. Optional.
- forms
An array, where each element corresponds to a desired project
form. Optional.
- forms_collapsed
A single string, where the desired form names are
separated by commas. Optional.
- events
An array, where each element corresponds to a desired project
event. Optional.
- events_collapsed
A single string, where the desired event names are
separated by commas. Optional.
- raw_or_label
A string (either 'raw' or 'label') that specifies
whether to export the raw coded values or the labels for the options of
multiple choice fields. Default is 'raw'.
- raw_or_label_headers
A string (either 'raw' or 'label' that
specifies for the CSV headers whether to export the variable/field names
(raw) or the field labels (label). Default is 'raw'.
- export_checkbox_label
specifies the format of checkbox field values
specifically when exporting the data as labels. If raw_or_label is
'label' and export_checkbox_label is TRUE, the values will be the text
displayed to the users. Otherwise, the values will be 0/1.
- export_survey_fields
A boolean that specifies whether to export the
survey identifier field (e.g., 'redcap_survey_identifier') or survey
timestamp fields (e.g., instrument+'_timestamp').
The timestamp outputs reflect the survey's completion time
(according to the time and timezone of the REDCap server.)
- export_data_access_groups
A boolean value that specifies whether or
not to export the redcap_data_access_group field when data access groups
are utilized in the project. Default is FALSE. See the details below.
- filter_logic
String of logic text (e.g., [gender] = 'male') for
filtering the data to be returned by this API method, in which the API will
only return the records (or record-events, if a longitudinal project) where
the logic evaluates as TRUE. An blank/empty string returns all records.
- datetime_range_begin
To return only records that have been created or
modified after a given datetime, provide a
POSIXct
value.
If not specified, REDCap will assume no begin time.
- datetime_range_end
To return only records that have been created or
modified before a given datetime, provide a
POSIXct
value.
If not specified, REDCap will assume no end time.
- col_types
A readr::cols() object passed internally to
readr::read_csv(). Optional.
- guess_type
A boolean value indicating if all columns should be
returned as character. If false, readr::read_csv() guesses the intended
data type for each column. Ignored if col_types is not null.
- guess_max
A positive integer passed to readr::read_csv() that
specifies the maximum number of records to use for guessing column types.
- verbose
A boolean value indicating if messages should be printed
to the R console during the operation. The verbose output might contain
sensitive information (e.g. PHI), so turn this off if the output might
be visible somewhere public. Optional.
- config_options
A list of options to pass to POST method in the
httr package. See the details below. Optional.