miracum / dqa-dqagui

Mirror of https://gitlab.miracum.org/miracum/dqa/dqagui

DQAgui

This is the repository of the R package ‘DQAgui’. It provides a graphical user interface to the functionalities implemented in DQAstats.

Installation

You can install DQAgui with:

install.packages("remotes")
remotes::install_github("miracum/dqa-dqagui")

Configuration

The database connection can be configured using environment variables. These can be set using the base R command Sys.setenv().

A detailed description, which environment variables need to be set for the specific databases can be found here.

Example

This is a basic example to demonstrate how to perform the data quality assessment with DQAgui:

library(DQAgui)

# define base paths for shinyFiles::shinyDirChoose
Sys.setenv(
  "CSV_SOURCE_BASEPATH" = system.file("demo_data", package = "DQAstats")
)
Sys.setenv(
  "CSV_TARGET_BASEPATH" = system.file("demo_data", package = "DQAstats")
)

# define path to utilities-folder
utils_path <- system.file("demo_data/utilities",
                         package = "DQAstats")

# filename of the metadata repository
mdr_filename <- "mdr_example_data.csv"

# directory for storing logfiles
logfile_dir <- tempdir()

launch_app(
  port = 3838,
  utils_path = utils_path,
  mdr_filename = mdr_filename,
  logfile_dir = logfile_dir,
  parallel = FALSE
)

To open the shiny application in your web-browser, go to localhost:3838.

Demo Usage / Deployment Examples

You can test the package without needing to install anything except docker. 💡 For further details, see the Wiki.

More Infos

• about MIRACUM: https://www.miracum.org/
• about the Medical Informatics Initiative: https://www.medizininformatik-initiative.de/index.php/de
• about Shiny: https://www.rstudio.com/products/shiny/
• RStudio and Shiny are trademarks of RStudio, Inc.