Installation

Installation

In order to use this tool you need a working LaTeX-installation, which is properly connected with R. We highly recommend to install the R-package tinytex and additionally required packages, as outlined below.

install.packages("tinytex")
tinytex::install_tinytex()

# update
tinytex::tlmgr_conf()

# define required packages
tex_pkg <- c(
    "amsfonts",  
    "amsmath",  
    "atveryend",  
    "babel",  
    "babel-german",  
    "caption",  
    "colortbl",  
    "dehyph-exptl",  
    "ec",  
    "environ",  
    "epstopdf-pkg",  
    "etoolbox",
    "float",  
    "geometry",  
    "graphics",  
    "graphics-def",  
    "hycolor",  
    "hyperref",  
    "hyphen-german",  
    "iftex",  
    "koma-script",  
    "latex-graphics-dev",  
    "latexconfig",  
    "lm",  
    "makecell",  
    "multirow",  
    "oberdiek",  
    "pdfcrop", 
    "pdflscape",  
    "tabu",  
    "tex-gyre-math",  
    "texlive-scripts",  
    "threeparttable",  
    "threeparttablex",  
    "titling",  
    "tools",  
    "trimspaces",  
    "ulem",  
    "varwidth",  
    "wrapfig",  
    "ulem",  
    "url",  
    "xcolor"
)

# install packages
tinytex::tlmgr_install(pkgs = tex_pkg)
tinytex::tlmgr_update()

Install DQAstats

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

Install DQAgui

install.packages("remotes")
remotes::install_url(
    paste0(
        "https://gitlab.miracum.org/miracum/dqa/dqagui/",
        "-/archive/master/dqagui-master.zip"
    )
)

Using Docker

You can test the package without needing to install anything execpt docker. To try out the package follow these instructions:

1. Make sure you have docker installed

2. Clone this repo

   git clone https://gitlab.miracum.org/miracum/dqa/dqastats.git dqastats
   cd dqastats

3. Run the containerized setup using

   docker-compose up

4. Go to ./output/ and see the created report.

Advanced dockerized usage

If you want to use your own docker-compose and .env file(s) you can do this simply by using them in this command:

docker-compose \
  -f docker-compose_miracum.yml \
  --env-file ../dqastats.env \
  up --build