search

CHOP-CGTInformatics / REDCapTidieR

Makes it easy to read REDCap Projects into R
https://chop-cgtinformatics.github.io/REDCapTidieR/
Other
33 stars 8 forks source link
r redcap redcap-api tidy-data

readme

REDCapTidieR

Lifecycle: stable R-CMD-check CRAN status Codecov test coverage OpenSSF Best Practices

The REDCapTidieR package provides an elegant way to import data from a REDCap project into an R environment. It builds upon the REDCapR package to query the REDCap API and then transforms the returned data into a set of tidy tibbles.

REDCapTidieR is especially useful for dealing with complex REDCap projects that are longitudinal or include repeating instruments or both.

Installation

The release version can be installed from CRAN.

install.packages("REDCapTidieR")

You can install the development version of REDCapTidieR from GitHub:

devtools::install_github("CHOP-CGTInformatics/REDCapTidieR")

Usage

Use read_redcap() together with bind_tibbles() to import data from all instruments into your environment.

Demonstration of using the read_redcap() and bind_tibbles() functions

REDCapTidieR supports labelled data using the labelled package, and it can generate statistical summaries using the skimr package.

Read the Getting Started vignette to learn more.

In addition, you can easily create collaborator-friendly Excel files using the write_redcap_xlsx() function:

redcap_uri <- "https://my.institution.edu/redcap/api/"
token <- "123456789ABCDEF123456789ABCDEF04"

my_redcap_data <- read_redcap(redcap_uri, token)
write_redcap_xlsx(my_redcap_data, file = "my_redcap_data.xlsx")
Sample REDCapTidieR .xlsx output using write_redcap_xlsx()

To learn more about how to work with and customize the output, read the Exporting to Excel vignette.

Collaboration

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 REDCapTidieR 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.

We’d like to thank the following folks for their advice and code contributions: Will Beasley and Paul Wildenhain.

Funding

This package was developed by the Children’s Hospital of Philadelphia Cell and Gene Therapy Informatics Team to support the needs of the Cellular Therapy and Transplant Section. The development was funded using the following sources: