README.md

In dqcheckrGUI: Point-and-Click GUI Client for 'dqcheckr'

dqcheckrGUI

A point-and-click Shiny interface for dqcheckr — automated data quality checks for recurring dataset deliveries.

Use this if you want to configure and run quality checks without writing any R code. If you prefer scripting, use dqcheckr directly.

Status: maintenance mode

dqcheckrGUI is feature-complete. It receives bug fixes and compatibility updates only — configuration features are developed in dqcheckr itself, which offers a script-based workflow that does not need this interface. Existing deployments continue to work unchanged.

What it does

• Walks you through setting up quality checks for a new dataset (wizard)
• Runs checks against incoming file deliveries and opens the HTML report
• Browses historical check results and drift comparisons

Installation

# Install dqcheckr first (required)
install.packages("dqcheckr")

# Install dqcheckrGUI from GitHub
devtools::install_github("mickmioduszewski/dqcheckrGUI")

Launch

dqcheckrGUI::run_app()

Or, if you have downloaded the source, double-click launch.command (Mac), launch.sh (Linux), or launch.bat (Windows).

Example configuration files

Example YAML configuration files using the Star Wars dataset are included with the package. Copy them to a local folder to use as a starting point:

file.copy(
  system.file("extdata/example_config", package = "dqcheckrGUI"),
  "my_config",
  recursive = TRUE
)

Learn more

See the dqcheckr documentation for a full description of all configuration options and quality checks.

dqcheckrGUI documentation built on July 25, 2026, 9:06 a.m.