Exports reports from a REDCap Database and formats data if requested
exportReports(rcon, report_id, factors = TRUE, labels = TRUE,
dates = TRUE, checkboxLabels = FALSE, ...)# S3 method for redcapDbConnection
exportReports(rcon, report_id, factors = TRUE,
labels = TRUE, dates = TRUE, checkboxLabels = FALSE, ...)
# S3 method for redcapApiConnection
exportReports(rcon, report_id, factors = TRUE,
labels = TRUE, dates = TRUE, checkboxLabels = FALSE, ..., proj = NULL)
A REDCap connection object as created by redcapConnection
.
Integer. Gives the report id of the desired report. This is located on the Report Builder page of the user interface on REDCap.
Logical. Determines if categorical data from the database is returned as numeric codes or labelled factors.
Logical. Determines if the variable labels are applied to the data frame.
Logical. Determines if date variables are converted to POSIXlt format during the download.
Logical. Determines the format of labels in checkbox
variables. If FALSE
labels are applies as "Unchecked"/"Checked".
If TRUE
, they are applied as ""/"[field_labe]" where [field_label]
is the label assigned to the level in the data dictionary. This option
is only available after REDCap version 6.0.
Additional arguments to be passed between methods.
A redcapProject
object as created by redcapProjectInfo
.
A record of exports through the API is recorded in the Logging section of the project.
Reports are exported based on their id number, which can be looked up in the Reports page of a project