Package {dqcheckrGUI}


Type: Package
Title: Point-and-Click GUI Client for 'dqcheckr'
Version: 0.2.0
Date: 2026-06-28
Description: A graphical user interface for the 'dqcheckr' package. Provides a point-and-click 'shiny' application for configuring dataset quality checks, running them against recurring file deliveries, and browsing historical check results — without writing any R code.
License: MIT + file LICENSE
URL: https://mickmioduszewski.github.io/dqcheckrGUI/, https://github.com/mickmioduszewski/dqcheckrGUI
BugReports: https://github.com/mickmioduszewski/dqcheckrGUI/issues
Encoding: UTF-8
Language: en-GB
Depends: R (≥ 4.2)
Imports: dqcheckr (≥ 0.2.2), shiny, bslib, shinyvalidate, shinyFiles, shinyAce, reactable, DT, callr, yaml, readr, DBI, RSQLite, stats, tools
Suggests: testthat (≥ 3.1.0), knitr, rmarkdown, shinytest2, withr, pkgdown
VignetteBuilder: knitr
Config/testthat/edition: 3
Config/roxygen2/version: 8.0.0
NeedsCompilation: no
Packaged: 2026-06-29 04:27:45 UTC; mick
Author: Mick Mioduszewski [aut, cre]
Maintainer: Mick Mioduszewski <mick@mioduszewski.net>
Repository: CRAN
Date/Publication: 2026-06-29 08:10:02 UTC

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

Description

A point-and-click 'shiny' front-end for dqcheckr – configure and run automated data quality checks on recurring dataset deliveries without writing any R code.

Getting started

Launch the app with run_app. On first run it will offer to create the standard project layout (‘config/’, ‘data/’, ‘reports/’) in the chosen directory.

The config directory can be set via the DQCHECKR_CONFIG_DIR environment variable or the config_dir argument to run_app. See the getting-started vignette for a full walkthrough including Windows and OneDrive setups: vignette("dqcheckrGUI", package = "dqcheckrGUI").

Related packages

dqcheckrGUI delegates all data processing to dqcheckr. See vignette("dqcheckr", package = "dqcheckr") for the core package introduction and vignette("specification", package = "dqcheckr") for the full config/schema reference.

These packages are only called from the 'shiny' app sourced at runtime via system.file("app", package = "dqcheckrGUI") (inst/app/R/*.R), so static analysis of R/ cannot see them as used – without a reference here, R CMD check reports "Namespaces in Imports field not imported from".

Author(s)

Maintainer: Mick Mioduszewski mick@mioduszewski.net

Authors:

See Also

Useful links:


Launch the dqcheckrGUI Shiny application

Description

Opens the point-and-click interface for configuring and running dqcheckr dataset quality checks.

Usage

run_app(config_dir = NULL, ...)

Arguments

config_dir

Path to the directory that contains (or will contain) ‘dqcheckr.yml’ and individual dataset ‘.yml’ files. Defaults to the DQCHECKR_CONFIG_DIR environment variable when set, otherwise ‘config/’ inside the current working directory. Passing this argument explicitly is recommended when launching from a script so that the correct project folder is used regardless of the R session's working directory.

...

Arguments passed to runApp (e.g. port, launch.browser).

Value

Called for its side effect; does not return a value.

See Also

vignette("dqcheckrGUI", package = "dqcheckrGUI") for a full setup walkthrough. run_dq_check for the underlying check function.

Examples

if (interactive()) {
  run_app()

  # Explicit project folder (recommended from a launcher script)
  # run_app(config_dir = file.path(getwd(), "config"))
}