This function is used by other functions to read and write values.
kernel_api(
redcap_uri,
post_body,
config_options,
encoding = "UTF-8",
content_type = "text/csv"
)
The URI (uniform resource identifier) of the REDCap project. Required.
List of contents expected by the REDCap API. Required.
A list of options to pass to POST
method in the
httr
package. See the details below. Optional.
The encoding value passed to httr::content()
. Defaults
to 'UTF-8'.
The MIME value passed to httr::content()
. Defaults
to 'text/csv'.
If the API call is unsuccessful, a value of
base::package_version("0.0.0")
will be returned. This ensures that a
the function will always return an object of class base::package_version.
It guarantees the value can always be used in utils::compareVersion()
.
config_options <- NULL
uri <- "https://bbmc.ouhsc.edu/redcap/api/"
token <- "9A81268476645C4E5F03428B8AC3AA7B"
post_body <- list(
token = token,
content = 'project',
format = 'csv'
)
if (FALSE) {
kernel <- REDCapR:::kernel_api(uri, post_body, config_options)
# Consume the results in a few different ways.
kernel$result
read.csv(text=kernel$raw_text)
as.list(read.csv(text=kernel$raw_text))
}