# User Manual
**Danuberegion Monitor - People & Skills**

___
David Zenz
_The Vienna Institute for International Economic Studies_

November 2022

---

<!--
## Technische Anforderungen

### Variante 1 - selbst gehosteter Shiny server
#### Shiny server
Open Source Shiny Server bietet eine Plattform, auf der Sie mehrere Shiny-Anwendungen auf einem einzigen Server hosten können, jede mit ihrer eigenen URL oder Port. Er ermöglicht die Unterstützung von nicht websocket-fähigen Browsern wie Internet Explorer 10 und ist unter einer AGPLv3-Lizenz verfügbar.

Es werden derzeit vorkompilierte Binaries für Ubuntu 16.04+, Red Hat/CentOS 6+ und SUSE Linux Enterprise Server 12+ angeboten.

#### R
Bevor Sie Shiny Server installieren, müssen Sie R und das Shiny R-Paket installieren.

### Variante 2 - Dockerized App
Docker ist eine freie Software zur Virtualisierung von Containern.
-->
## Frontend
Das Frontend erlaubt die Visualisierung der Daten, welche für den Donauraummonitor 2021 zusammengetragen wurden. Die dargestellten Graphen sind komplett interaktiv und reaktiv, und erlauben unterschiedliche, auf die Indikatoren angepasste Darstellungsformen, von Linien-, über Balkendiagrammen, Mischformen von Balken- und Punktdiagrammen, sowie interaktiven Landkarten.

### Data Explorer
Der `Data Explorer` erlaubt die Darstellung der zusammengetragenen Variablen in den vordefinierten, von den Indikatoren abhängigen Darstellungsformen

- Liniendiagramm
- Balkendiagramm
- Säulendiagramm
- Mischform Balken- und Punktdiagramm

Für eine optimierte Darstellung einer umfangreicheren Auswahl an Daten wird die Auswahl im Hintergrund überprüft und automatisch nach Reihen/Spalten oder nach Ausprägungen facetiert. Im nachfolgenden Bild zu sehen an einem Beispiel: Auswahl des Indikator `Employment rate (%)`, sowie Auswahl aller Geschlechter (`Gender`) und Ausbildungslevels (`Education`).


In dieser Darstellung wird auf der x-Achse nach den Ländern (`Countries`), und auf der y-Achse anch den Ausbildungslevels (`Education`) facetiert. Das Geschlecht (`Gender`) wird in diesem Fall auf der x-Achse dargestellt.

Wählt man nun mehrere Jahre (`Years`), alle Geschlechter (`Gender`), aber nur ein Ausbildungsniveau (`Education`), so werden die dabei enstandenen Säulendiagramme automatisch auf Zeilen/Spalten aufgeteilt.


Die Jahre werden hier auf der x-Achse dargestellt, die Geschlechter aufgetrennt, und die Länder facetiert um eine bessere Vergleichbarkeit zu erzielen

#### Darstellungsbeispiele
##### Liniendiagramm

##### Balkendiagramm

##### Säulendiagramm

##### Mischform
In dieser Form werden Punkt auf einem Balkendiagramm abgebildet um unterschiedliche Ausprägungen auf einmal darzustellen.

#### Filtermöglichkeiten
am Beispiel `Employment rate (%)`

Auf der linken Seite des Bildschirmes erlaubt das interaktive Menü eine reaktive Filterung der zu darstellenden Daten, wobei hier zwischen den unterschiedlichen Themen (`Topic`), Variablen (`Indicator`), den einzelnen Ländern (`Countries`), davon abhängigen anderen möglichen Ausprägungen wie Geschlecht/Alter/Ausbildung (`Gender`/`Age`/`Education`), sowie den einzelnen Jahren (`Years`) in unterschiedlicher Dynamik (`Time period`/`Selected years`) gefiltert werden kann.

#### Downloads
Im Menü auf der rechten Seite der Grafik befindet sich für die Nutzer:innen die Möglichkeit die Daten im gewünschten Format herunterzuladen.


Für die Nutzer:innen werden vier unterschiedliche Formate von Datendownloads angeboten:

1. `.csv` (Comma-separated values / Textformat)
2. `.xlsx` (Excel Tabelle)
3. `.dta` (Stata Datenformat)
4. `.rds` (R Datenformat)

#### Definitionen und Notes
Auf der rechten Seite befindet sich auch die Darstellung zusätzlicher Infos wie die Methodologische Definition der Variable (`Definition`), sowie weitere nützliche Notizen (`Notes`).


Sollte der Platz für die Darstellung auf einer Seite nicht ausreichen, wird ein Button mit dem Titel `Read more` dargestellt, welcher es erlaubt die Informationen in einem Pop-up komplett darzustellen (siehe nachfolgendes Bild).



### Selected Maps
`Selected Maps` erlaubt die Darstellung ausgewählter Indikatoren als interaktive Karte.

#### Filtermöglichkeiten
In dieser Darstellungsform gibt es nur sehr eingeschränkte Filtermöglichkeiten, nämlich nach
1. `Topic`
2. `Indicator`
3. `Year`

Die Filtermöglichkeiten befinden sich, ähnlich dem `Data Explorer` auf der linken Seite der Grafik. Das ausgewählte Jahr (`Year`) lässt sich mittels Slider festlegen, während die Variable `Topic` und `Indicator` mittels Dropdown-Menü ausgewählt werden.


#### Definitionen und Notes
Wie beim `Data Explorer` befindet sich auch die Darstellung zusätzlicher Infos wie die Methodologische Definition der Variable (`Definition`), sowie weitere nützliche Notizen (`Notes`) auf der rechten Seite der interaktiven Grafik.


## Backend
Das Backend erlaubt
- Update der Daten
- Versionierung der Daten
- Auswertung der Zugriffe auf das Frontend

für authorisierte Nutzer:innen. Die Authorisierung basiert auf einer verschlüsselten _SQLite_ Datenbank (https://www.sqlite.org/). Die Passwort hashing Funktion basiert auf dem _scrypt_ Algorithmus (siehe https://www.tarsnap.com/scrypt/scrypt.pdf und https://www.rfc-editor.org/rfc/rfc7914).

### Log-in
Das Betreten des Backends erfordert eine Authorisierung mittels Logins (Username/Passwort).
Nach erfolgter Authentifizierung wird man automatisch in den gesicherten Bereich weitergeleitet.

<!--
### Startseite
-->

### Upload
Im Upload-Bereich können Nutzer:innen die dem Frontend zugrundeliegenden Daten aktualisieren.
Zu diesem Zweck muss ein, einer vordefinierten Form folgendes, `csv` Textfile in `UTF-8` Kodierung hochgeladen werden. Die Anforderungen an Form und Kodieren erlauben ein friktionsfreies Hochladen der aktualisierten Daten in das bestehende System.

#### Beispiel Upload
Nach dem Upload des `csv` Textfiles wird eine Übersicht der hochgeladenen Daten im Rohformat dargestellt.

Nach Betätigung des Buttons `check`, wird eine Übersicht über die Änderungen in den Reitern darunter dargestellt.

#### Beispiel Summary
Im Tab `Summary` wird eine generelle Übersicht der Änderungen im Vergleich zum letzthochgeladenen Datensatz gezeigt.

#### Beispiel Details
Der Tab `Details` stellt eine detailliertere Ansicht des kompletten Datensatzes sowie der Änderungen dar, und bietet auch Filtermöglichkeiten um Teilmengen des Datensatzes sowie der respektiven Änderungen zeigen zu können.

#### Beispiel Data
Im Tab `Data` kann man sich die einzelnen Unterschiede in den Datenzeilen hervorheben lassen.
Auf der linken Seite sieht man die alten Einträge (in rot eingefärbt), und auf der rechten Seite die Änderungen (in grün eingefärbt). Es werden standardmäßig nur die relevanten Zeilen angezeigt, bei Bedarf ist es aber auch möglich alle anderen Zeilen einzublenden.

#### Beispiel Topics
Im Tab `Topics` kann man sich die Unterschiede bei den thematischen Metadaten anzeigen lassen.
Hier sieht man etwaige Änderungen bei
- Topic description
- Topic code
- Indicator description
- Indicator code
- Indicator definition

#### Beispiel Meta data
Im letzten Tab `Meta` werden alle Änderungen der restlichen Metadaten gezeigt.
Wieder sind (bei Änderungen) die vorhergehenden Einträge in rot hervorgehoben, und die neuen Einträge in grün hervorgehoben.

### Versionierung
Der Bereich `Versionierung` erlaubt das wechseln zwischen unterschiedlichen Datenuploads. Auf der linken Seite gibt es per Dropdown-Auswahl die Möglichkeit einen beliebigen, bereits hochgeladenen, Datensatz auszuwählen und mit dem Button `change` auf diesen umzuschalten.

In der Mitte wird die dazugehörige `Commit message` dargestellt. Auf der rechten Seite wird als zusätzliche Info der Datenbestand pro Tabelle dargestellt, um zu sehen ob es beim hochladen des Datensatzes möglicherweise einen Fehler gab.

### Statistics
Der Bereich `Statistics` zeigt rudimentäre Benutzungsstatistiken des `Danube Region Monitor - People and Skills` Online Tools
Derzeit werden die Darstellung von Nutzung
- über die Zeit
- nach Dauer
- nach Auflösung
erlaubt.

### User Administration
Über den Button `Administrator mode` im rechten unteren Bildschirmbereich wird der Admin-Bereich aufgerufen

Die Benutzer Administration erlaubt
- die Verwaltung des Benutzerkontos:
- Benutzer hinzufügen,
- ändern, und
- löschen
- den Benutzer auffordern, sein Passwort zu ändern
- Protokolle über die Nutzung der Administrations-Anwendung einzusehen
-

continued: