View source: R/redcap-event-instruments.R
redcap_event_instruments | R Documentation |
Export the instrument-event mappings for a project (i.e., how the data collection instruments are designated for certain events in a longitudinal project). (Copied from "Export Instrument-Event Mappings" method of REDCap API documentation, v.10.5.1)
redcap_event_instruments( redcap_uri, token, arms = c("1"), verbose = TRUE, config_options = NULL )
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. |
arms |
A character string of arms to retrieve. (Default: '1') |
verbose |
A boolean value indicating if |
config_options |
A list of options to pass to |
The full list of configuration options accepted by the httr
package is
viewable by executing httr::httr_options()
. The httr
package and
documentation is available at https://cran.r-project.org/package=httr.
Currently, a list is returned with the following elements,
data
: An R base::data.frame()
where each row represents one column
in the REDCap dataset.
success
: A boolean value indicating if the operation was apparently
successful.
status_code
: The
http status code
of the operation.
outcome_message
: A human readable string indicating the operation's
outcome.
elapsed_seconds
: The duration of the function.
raw_text
: If an operation is NOT successful, the text returned by
REDCap. If an operation is successful, the raw_text
is returned as an
empty string to save RAM.
Victor Castro, Will Beasley
The official documentation can be found on the 'API Help Page' and 'API Examples' pages on the REDCap wiki (i.e., https://community.projectredcap.org/articles/456/api-documentation.html and https://community.projectredcap.org/articles/462/api-examples.html). If you do not have an account for the wiki, please ask your campus REDCap administrator to send you the static material.
redcap_instruments()
## Not run: uri <- "https://bbmc.ouhsc.edu/redcap/api/" token <- "0434F0E9CF53ED0587847AB6E51DE762" ds_event_instrument <- REDCapR::redcap_event_instruments(redcap_uri=uri, token=token)$data ## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.