clean: Generate clean data frames from cleaning scripts created in...
In wizaRdry: A Magical Framework for Collaborative & Reproducible Data Analysis

clean

R Documentation

Generate clean data frames from cleaning scripts created in the ./clean directory

Description

This function processes requests for clean data sequentially for specified measures. It makes a request to the appropriate API for the named measure or measures and runs the associated data cleaning routines. It then runs a series of unit tests to verify that the data quality standards are met.

Usage

clean(..., csv = FALSE, rdata = FALSE, spss = FALSE, skip_prompt = FALSE)

Arguments

`...`	Strings, specifying the measures to process, which can be a Mongo collection, REDCap instrument, or Qualtrics survey.
`csv`	Optional; Boolean, if TRUE creates a .csv extract in ./tmp.
`rdata`	Optional; Boolean, if TRUE creates an .rdata extract in ./tmp.
`spss`	Optional; Boolean, if TRUE creates a .sav extract in ./tmp.
`skip_prompt`	Logical. If TRUE, skips confirmation prompts. If FALSE (default), prompts for confirmation unless the user has previously chosen to remember their preference.

Value

Prints the time taken for the data request process.

Author(s)

Joshua Kenney joshua.kenney@yale.edu

Examples

## Not run: 
  clean("prl", csv=TRUE)
  clean("rgpts", "kamin", rdata=TRUE)
  
  # Skip confirmation prompts
  clean("prl", csv=TRUE, skip_prompt=TRUE)

## End(Not run)

wizaRdry documentation built on June 8, 2025, 11:30 a.m.