Skip to content

Getting_started

Lorenz Kapsner edited this page Dec 8, 2021 · 1 revision

Getting started

When having installed the DQA tool (see Installation) you can go ahead and carry out your first DQA analysis with the demo data included in the DQAstats R package:

# Load library DQAstats:
library(DQAstats)

# Set environment vars to demo files paths:
Sys.setenv("EXAMPLECSV_SOURCE_PATH" = system.file("demo_data",
                                                  package = "DQAstats"))
Sys.setenv("EXAMPLECSV_TARGET_PATH" = system.file("demo_data",
                                                  package = "DQAstats"))
# Set path to utilities folder where to find the mdr and template files:
utils_path <- system.file("demo_data/utilities",
                          package = "DQAstats")

# Execute the DQA and generate a PDF report:
results <- DQAstats::dqa(
  source_system_name = "exampleCSV_source",
  target_system_name = "exampleCSV_target",
  utils_path = utils_path,
  mdr_filename = "mdr_example_data.csv",
  output_dir = "output/"
)

For adapting the DQA tool to analyse your own datasets, a short description can be found here (with references to more detailed information, if required).