launch_app {DQAgui}

Launch the DQA graphical user interface (GUI)

Description

Launch the DQA graphical user interface (GUI)

Usage

launch_app(
  port = 3838,
  utils_path = system.file("demo_data/utilities", package = "DQAstats"),
  mdr_filename = "mdr_example_data.csv",
  logfile_dir = tempdir(),
  parallel = FALSE,
  ncores = 2,
  demo_usage = FALSE
)

Arguments

port

The port, the MIRACUM DQA Tool is running on (default: 3838)

utils_path

The path to the utilities-folder, containing the metadata repository files (mdr.csv inside the folder MDR), JSON files with SQL statements (inside the folder SQL), config files for the database connection (settings_default.yml) and the email address used for the data map (email.yml), a JSON file containing site names (inside the folder MISC) and a markdown template to create the PDF report (DQA_report.Rmd inside the folder RMD).

mdr_filename

The filename of the mdr (e.g. "mdr_example_data.csv").

logfile_dir

Is the absolute path to the directory where the logfile will be stored. If not path is provided the tempdir() will be used.

parallel

A boolean. If TRUE, initializing a future::plan() for running the code (default: FALSE).

ncores

A integer. The number of cores to use. Caution: you would probably like to choose a low number when operating on large datasets. Default: 2.

demo_usage

A boolean. If TRUE, a box is shown on the dashboard with further instructions on how to use / configure the tool.

Value

Executing this function returns a DQAgui shiny application.

Examples

if (interactive()) {
  launch_app()
}