Benutzerkonfiguration • statR

Allgemeine Informationen

Die Benutzerkonfiguration erlaubt es, Informationen den Excel-Outputs mitzugeben. Diese werden global gesetzt und jedes Excel-File enthält die selben Informationen. Dies ermöglicht, Team-Spezifische oder Organisations-Spezifische Konfigurationen zu setzten. Die Benutzerkonfiguration lebt nicht mehr im Package direkt, sondern es wird ein Pfad zur Konfiguration angegeben. Der Grund für diese Auslagerung der Informationen ist, dass so ein ganzes Team auf die Gleiche Konfiguration zugreifen kann. Falls keine eigene Konfiguration verwenet wird, fallen die Werte auf einen Default-Wert zurück, welche im Package hinterlegt sind.

Erstellen einer eigenen Benutzerkonfiguration

Die Benutzerkonfiguration wird in einem YAML-File gemacht. Sie muss gleich sein wie das untenstehende Beispiel:

# Configuration file for statR
statR_config_name: default

# Contact information
contactdetails:
  statR_organization: Statistisches Amt des Kantons Zürich
  statR_name: Datashop
  statR_phone: +41 43 259 75 00
  statR_email: datashop@statistik.zh.ch
  statR_homepage: http://www.statistik.zh.ch
  statR_openinghours:
    - Bürozeiten
    - Montag bis Freitag
    - 09:00 bis 12:00
    - 13:00 bis 16:00

# Logo: this can be one of the values statzh or zh, or a path to an image
logo:
  statR_logo: statzh
  statR_logo_width: 2.145
  statR_logo_height: 0.7865

# Prefixes for strings
prefixes:
  statR_prefix_date: "Aktualisiert am:"
  statR_prefix_author: "durch:"
  statR_prefix_phone: "Tel."
  statR_prefix_order_id: "Auftragsnr.:"

# Default values
defaults:
  statR_index_title: Inhalt
  statR_index_source: Statistisches Amt des Kantons Zürich
  statR_default_plot_width: 6
  statR_default_plot_height: 3

# Miscellaneous
statR_date_format: "%d.%m.%Y"

Du hast die folgenden Konfigurations-Möglichkeiten:

contactdetails

In diesem Bereich kannst du die Kontakt-Informationen deines Teams oder der Organisation angeben.

logo

Hier kannst du die Angaben zum Logo machen, welches in den Excel-Files angezeigt werden soll. Wenn du nicht das standard KTZH-Logo verwenden möchtest, musst du einen Pfad zu einem anderen Logo angeben.

prefixes

Hier kannst du bestimmte Schreibweisen definieren. Dieser Teil ist vor allem dafür gedacht, dass eine andere Sprache konfiguriert werden kann.

defaults

Hier können bestimmte Default Settings gesetzt werden. Unter anderem kannst du hier für das Index-Scheet (relevant bei datasets.xlsx) einen Titel sowie die Source definieren. Zudem kannst du hier default Plot-Grössen definieren. Diese Angaben könnten in den Funktionen auch überschrieben werden, wenn ein Plot dem Standard abweicht.

Verwenden einer eigenen Benutzerkonfiguration

Eine eigene Benutzerkonfiguration wird nicht automatisch im Package verwendet. Wir müssem dem Package zuerst sagen, wo unsere Konfiguration liegt.

Dazu gibt es ein paar Hilfsfunktionen:

Mit addUserConfig() kann eine neuer Konfiguration registriert werden.
Mit updateUserConfig() kann ein Pfad angepasst werden.
Mit removeUserConfig() kann eine Konfiguration entfernt werden.

Wenn du nun zum Beispiel eine Team-Konfiguration verwenden möchtest, dann kannst du wie folgt vorgehen:

Kopiere die oben aufgeführten Angaben und passe sie für dich an
Speichere das File als YAML ab (.yaml)
registriere das neue Konfigurationsfile (hier als Beispiel für team_data):

addUserConfig(name = "team_data", path = "der_Pfad_zum_file")
wenn du eine Exce-Funktion aufrufst, setze den Parameter config = "team_data"

Du hast auch die möglichkeit mehrere Konfigurationen zu registrieren. Du kannst dann einfach mit dem config-Parameter bestimmen, welche Konfiguration angezogen werden soll.