README.md 1.64 KB
Newer Older
kapsner's avatar
kapsner committed
1
2
# miRacumDQA  

Lorenz Kapsner's avatar
Lorenz Kapsner committed
3
4
5
6
7
<!-- badges: start -->
[![pipeline status](https://gitlab.miracum.org/miracum/dqa/miracumdqa/badges/master/pipeline.svg)](https://gitlab.miracum.org/miracum/dqa/miracumdqa/commits/master)
[![coverage report](https://gitlab.miracum.org/miracum/dqa/miracumdqa/badges/master/coverage.svg)](https://gitlab.miracum.org/miracum/dqa/miracumdqa/commits/master)
<!-- badges: end -->

8
This is the repository of the MIRACUM data quality assessment tool (DQA tool). 
kapsner's avatar
kapsner committed
9
10
11

## Installation

Lorenz Kapsner's avatar
Lorenz Kapsner committed
12
You can install the with the following commands. Please make sure to also install the required packages in the correct order.
kapsner's avatar
kapsner committed
13
14
15

``` r
install.packages("devtools")
Lorenz Kapsner's avatar
Lorenz Kapsner committed
16
options('repos' = 'https://ftp.fau.de/cran/')
Lorenz Kapsner's avatar
Lorenz Kapsner committed
17
devtools::install_git("https://gitlab.miracum.org/miracum/dqa/miracumdqa.git")
kapsner's avatar
kapsner committed
18
19
```

20
21
# Configuration 

Lorenz Kapsner's avatar
Lorenz Kapsner committed
22
23
24
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](https://github.com/miracum/misc-dizutils/blob/master/README.md).
25

kapsner's avatar
kapsner committed
26
27
## Example

28
This is a basic example which shows you how to launch the MIRACUM DQA tool:
kapsner's avatar
kapsner committed
29
30
31

``` r
library(miRacumDQA)
Lorenz Kapsner's avatar
Lorenz Kapsner committed
32
launch_dqa_tool()
kapsner's avatar
kapsner committed
33
34
```

Lorenz Kapsner's avatar
Lorenz Kapsner committed
35
To open the shiny application in your webbrowser, go to http://localhost:3838.
kapsner's avatar
kapsner committed
36

37
# More Infos:
Lorenz Kapsner's avatar
Lorenz Kapsner committed
38
39
40

- about MIRACUM: [https://www.miracum.org/](https://www.miracum.org/)
- about the Medical Informatics Initiative: [https://www.medizininformatik-initiative.de/index.php/de](https://www.medizininformatik-initiative.de/index.php/de)
41
- about Shiny: https://www.rstudio.com/products/shiny/  
Lorenz Kapsner's avatar
Lorenz Kapsner committed
42
- RStudio and Shiny are trademarks of RStudio, Inc.