View source: R/redcap-read-dag.R
redcap_dag_read | R Documentation |
This function reads all available data access groups from
REDCap an returns them as a base::data.frame()
.
redcap_dag_read( redcap_uri, token, http_response_encoding = "UTF-8", locale = readr::default_locale(), 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. |
http_response_encoding |
The encoding value passed to
|
locale |
a |
verbose |
A boolean value indicating if |
config_options |
A list of options to pass to |
Currently, a list is returned with the following elements:
data
: An R base::data.frame()
of all data access groups of the project.
success
: A boolean value indicating if the operation was apparently
successful.
status_codes
: A collection of
http status codes,
separated by semicolons. There is one code for each batch attempted.
outcome_messages
: A collection of human readable strings indicating the
operations' semicolons. There is one code for each batch attempted. In an
unsuccessful operation, it should contain diagnostic information.
elapsed_seconds
: The duration of the function.
Jonathan M. Mang
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.
## Not run: uri <- "https://bbmc.ouhsc.edu/redcap/api/" token <- "9A81268476645C4E5F03428B8AC3AA7B" REDCapR::redcap_dag_read(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.