data.frame.redcap_read_oneshot. The internals
differ in that redcap_read retrieves subsets of the data, and then combines them before returning
(among other objects) a single data.frame. This function can be more appropriate than
redcap_read_oneshot when returning large datasets that could tie up the server.
redcap_read(batch_size = 100L, interbatch_delay = 0.5, continue_on_error = FALSE, redcap_uri, token, records = NULL, records_collapsed = "", fields = NULL, fields_collapsed = "", events = NULL, events_collapsed = "", export_data_access_groups = FALSE, raw_or_label = "raw", verbose = TRUE, config_options = NULL, id_position = 1L)FALSE, which prevents subsequent batches from running. Required.FALSE. See the details below.'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'.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.POST method in the httr package. See the details in redcap_read_oneshot() Optional.data: An R data.frame of the desired records and columns.
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.
records_collapsed: The desired records IDs, collapsed into a single string, separated by commas.
fields_collapsed: The desired field names, collapsed into a single string, separated by commas.
elapsed_seconds: The duration of the function.
redcap_read_oneshot to select and return data.
Initially, only primary key is queried through the REDCap API. The long list is then subsetted into partitions,
whose sizes are determined by the batch_size parameter. REDCap is then queried for all variables of
the subset's subjects. This is repeated for each subset, before returning a unified data.frame.The function allows a delay between calls, which allows the server to attend to other users' requests.
For redcap_read to function properly, the user must have Export permissions for the
`Full Data Set'. Users with only `De-Identified' export privileges can still use
redcap_read_oneshot. To grant the appropriate permissions:
The official cURL site discusses the process of using SSL to verify the server being connected to.
## Not run:
# library(REDCapR) #Load the package into the current R session.
# uri <- "https://bbmc.ouhsc.edu/redcap/api/"
# token <- "9A81268476645C4E5F03428B8AC3AA7B"
# redcap_read(batch_size=2, redcap_uri=uri, token=token)
# ## End(Not run)
Run the code above in your browser using DataLab