REDCapExploreR provides exploratory tools for REDCap projects accessed through the REDCap API. Use it to build structured codebooks, review form completion with record status dashboards, and generate general data quality reports.
You can install the development version of REDCapExploreR like so:
devtools::install_github("CHOP-CGTInformatics/REDCapExploreR")Store REDCap credentials outside your scripts, then pass them to the build functions:
library(REDCapExploreR)
redcap_uri <- Sys.getenv("REDCAP_URI")
token <- Sys.getenv("REDCAP_TOKEN")
status_data <- build_record_status_data(
redcap_uri = redcap_uri,
token = token
)
plot_record_status(status_data)
codebook <- build_codebook(redcap_uri = redcap_uri, token = token)
quality_report <- build_quality_report(redcap_uri = redcap_uri, token = token)The package includes mock_redcap_project, mock_record_status_data,
mock_codebook, and mock_quality_report for offline exploration. See
Get
Started
for an overview, the function
reference
for complete API documentation, and the quality report
article
for a comprehensive guide to quality report checks, output elements, and
assumptions.
We invite you to give feedback and collaborate with us! If you are familiar with GitHub and R packages, please feel free to submit a pull request. Please do let us know if REDCapExploreR fails for whatever reason with your database and submit a bug report by creating a GitHub issue.
Please note that this project is released with a Contributor Code of Conduct. By participating you agree to abide by its terms.