data.frame
.
Each row in the data dictionary corresponds to one field in the project's dataset.
redcap_metadata_read(redcap_uri, token, forms = NULL, forms_collapsed = "", fields = NULL, fields_collapsed = "", verbose = TRUE, config_options = NULL)
message
s 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.
forms_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.
## Not run:
# library(REDCapR) #Load the package into the current R session.
# uri <- "https://bbmc.ouhsc.edu/redcap/api/"
# token <- "9A81268476645C4E5F03428B8AC3AA7B"
# redcap_metadata_read(redcap_uri=uri, token=token)
# ## End(Not run)
Run the code above in your browser using DataLab