REDCap Filler provides a testing and development service to users of Vanderbilt University's REDCap. It generates and loads synthetic test data into a REDCap project, using the project's design to guide test data generation. This data-driven process allows rapid data creation with minimal effort. This provides a low-cost way to test many of the project features. It creates test data as input for reporting and other downstream processes.
The redcapfiller package is only available as source code on GitHub. Install it from GitHub inside R or RStudio using the remotes package:
install.packages("remotes") # Run this line if the 'remotes' package hasn't been installed already.
remotes::install_github("ctsit/redcapfiller")See Getting started with redcapfiller to learn how to use redcapfiller.
REDCap Filler does not yet understand all the dimensions of a modern REDCap project. It can fill the categorical fields. It can fill unvalidated text fields and the text validation types date, datetime, email, integer, number, phone, and zip code. It ignores all other field types and validation types and will not attempt to fill them. Filler can fill classic and longitudinal projects, but not if they have repeating forms, repeating events, or randomization enabled. It does not honor form display logic and ignores all fields governed by branching logic.
- Works on classic projects and longitudinal projects.
- Uses the REDCap API to read the project design and write the synthetic data.
- Fills categorical fields (providing a uniform random distribution).
- Fills unvalidated text fields and fields with common text validation types: date, datetime, email, integer, number, phone, and zip code.
- Provides random-normal distributions for numeric and date fields.
- Uses "Lorem ipsum" text for non-validated text fields.
- Injects simple default randomness where practicable for other types.
- Leaves the form completed fields set to 'Incomplete' (red).
- Does not violate basic data constraints defined in the data dictionary (e.g., validation types, ranges where applicable).
- Populates specified events in longitudinal projects.
- Fills a specified number of records.
Current Limitations:
- Does not yet support projects with repeating instruments or repeating events.
- Does not yet support projects with randomization enabled.
- Ignores fields governed by Branching Logic (BL) and will not attempt to fill them.
- Does not evaluate Form Display Logic (FDL).
- Does not yet support all text validation types beyond those listed above.
This project aims to populate complex REDCap projects using the project design. If the REDCap API exposes a design dimension, we plan to use that to guide how the Filler populates projects. Yet, that will take some time to develop fully. This is the proposed timeline of features:
- Complete support for any text validation types currently missing.
- Add support for repeating events and repeating forms.
- Skip randomization fields to allow support for projects with randomization.
- Allow users to specify non-uniform distributions for categorical fields and non-default distributions for range fields.
- Allow configuration of inter-record and intra-record date offsets.
- Add support for evaluating Branching Logic.
- Add support for evaluating Form Display Logic.
We encourage input and collaboration. If you're familiar with GitHub and R packages, submit a pull request. If you'd like to report a bug or suggest, please create a GitHub issue; issues are usually a good place to ask public questions, too. However, email Philip if you prefer an offline dialog ([email protected]).
We'd like to thank the REDCap Community for their advice and contributions to the design of REDCap Filler.