From 62806feea0dcbba7ecc8dd4073b3033ca0cb12bf Mon Sep 17 00:00:00 2001 From: Daniel Kraus Date: Wed, 2 Jan 2019 15:46:21 +0100 Subject: [PATCH] =?UTF-8?q?README.md=20vervollst=C3=A4ndigt.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 42 +++++++++++++++++++++++++++++++++++++++--- 1 file changed, 39 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index efb4e4a..8e18e96 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,36 @@ Statistische Auswertung der Vorhofkatheter-Datenbank. Man benötigt: -* [R](https://www.r-project.org) -* [packrat](http://rstudio.github.io/packrat/) +* [R][] +* [packrat][] +* Kenntnisse von [ggplot2][] und des [tidyverse][] -Die Datei `vhk.csv` wird von der Abfrage `qryExportToCsv` generiert. +Die benötigte Datei `vhk.csv`, die aus Datenschutzgründen nicht in +diesem Repository enthalten ist, wird von der Abfrage `qryExportToCsv` +generiert. Beim Export muß folgendes Format eingehalten werden: + +* Erste Zeile enthält Feldbezeichnungen. +* Felder werden durch Kommata getrennt, nicht durch Semikolons. +* Dezimalzeichen ist der Punkt, nicht das Komma. +* Text wird mit doppelten Anführungszeichen umschlossen. +* Kodierung ist UTF-8. +* Kalenderdaten haben das Format "YYYY-MM-DD". + +Das Skript erwartet folgende Feldbezeichnungen: + +| Feld | Bedeutung +|--------------------------------|---------------------------------------------------- +| `Date` | Implantationsdatum +| `Age` | Alter des Patienten bei Implantation +| `Sex` | Geschlecht des Patienten +| `Surgeon` | Name des Implanteurs +| `Assistant` | Name des OP-Assistenten +| `InsertionSite` | Implantationsgefäß +| `Side` | Seite (links/rechts) +| `InsertionFluoroscopyDuration` | Durchleuchtungsdauer bei Implantation (in Sekunden) +| `RemovalDate` | Explantationsdatum (falls zutreffend) +| `RemovalReason` | Grund für die Explantation +| `RemovalSurgeon` | Explanteur Es gibt kein traditionelles R-Skript, sondern eine R-Markdown-Datei, die den Code zum Erzeugen der Abbildungen enthält. Als Präsentationsformat @@ -16,3 +42,13 @@ eignen sich HTML mit Slidy und PDF am besten. HTML mit ioslides kann vom in der Klinik immer noch installierten Internet Explorer nicht dargestellt werden, und der PowerPoint-Export klappt auch nicht so gut (Stand 1/2019). +## Mitmachen + +Die URL zum Klonen dieses Projektes ist ähnlich wie bei Github oben rechts zu +sehen. Für Pull Requests benötigt man einen Account auf dieser Gitea-Instanz, +der nach formloser Mail an eingerichtet werden kann. + +[R]: https://www.r-project.org +[packrat]: http://rstudio.github.io/packrat +[ggplot2]: https://ggplot2.tidyverse.org +[tidyverse]: https://www.tidyverse.org