Im Zuge der Seminar-, Bachelor-, Master- oder Doktorarbeit müssen häufig statistische Auswertungen in R durchgeführt werden. Nachdem die R Programmierung erfolgt ist, werden die Ergebnisse häufig anhand von Screenshots, mittelbar über einen Excel-Export oder sogar manuell in die Studienarbeit (Word-Dokument) übertragen. Dies ist nicht nur fehleranfällig, sondern auch noch richtig aufwendig. Daher wird in diesem Artikel R Markdown vorgestellt.
Sie benötigen beratende Hilfe bei Ihrer statistischen Auswertung in R oder möchten eine R Auswertung (inkl. Dokumentation in R Markdown) bestellen, dann zögern Sie nicht uns zu kontaktieren (Kontaktdaten unten rechts). Unsere Experten helfen Ihnen gerne weiter (kostenloses unverbindliches Erstgespräch)!
1. R Markdown - Was ist das ?
Mit Hilfe von R Markdown ist es möglich Code, Ergebnisse und freien Text (inkl. Bilder und Formeln) in einem einzigen sog. R Markdown (.rmd) Dokument zu kombinieren. R Markdown eignet sich folglich sehr gut, um Analyseschritte, dahinterstehende Gedanken sowie Ergebnisse der statistischen Auswertungen festzuhalten. Außerdem können R Markdown Dokumente schnell in andere Dokumenttypen – z. B. HTML-Websiten, PDF-Dateien oder Word-Dokumente – umgewandelt werden. Aus diesen Gründen entwickelt sich R Markdown in Unternehmen zusehends zum Quasi-Standard für die Dokumentation von R-Projekten. Außerdem verwenden es auch immer mehr Studenten für eine empirische Seminar-, Bachelor-, Master- oder Doktorarbeit.
2. R Markdown - Vorbereitung
Es wird in diesem Artikel davon ausgegangen, dass Sie bereits R und RStudio installiert haben. Falls dies nicht der Fall ist, finden Sie hier eine detaillierte Installationsanleitung. Die RStudio IDE ist zwar nicht zwingend erforderlich, wird aber empfohlen, da es dem durchschnittlichen R Anwender die Arbeit mit R Markdown erleichtert. Falls RStudio nicht genutzt werden soll, muss der in RStudio enthaltene freie Parser für Multidokumentenformate Pandoc seperat installiert werden. Wir gehen hier allerdings davon aus, dass Sie RStudio nutzen und starten mit der Installation des rmarkdown-Pakets . Nutzen Sie hierzu den folgenden R-Befehl:
Falls eine PDF-Datei erzeugt werden soll, muss zudem LaTeX installiert werden. Wer LaTeX nur in Kombination mit R Markdown nutzen will, installiert hierzu am besten die LaTeX Distribution TinyTeX. Die Installation ist dank des R-Pakets tinytex unkompliziert mit Hilfe der folgenden R Anweisungen möglich:
Im Anschluss an die Installation können R Markdown Dokumente (.rmd) zu PDF-Dateiern konvertiert werden. Falls LaTeX dagegen auch selbstständig ohne R Markdown oder Arbeit mit dem Terminal genutzt werden soll, wird die Installation von MiKTeX oder TeX Live empfohlen.
3. Unser erstes R Markdown Dokument
Geschafft! Endlich können wir mit der Erstellung unseres ersten R Markdown Dokuments beginnen. Hierzu wählen wir in der Menüleiste von RStudio Datei --> Neue Datei --> R Mardown aus. Daraufhin erscheint ein Pop-up-Fenster. Bitte geben Sie in dem Fenster den Titel des Dokuments, den Namen des Autors und das Dateiformat (hier: PDF), in welches standardmäßig konvertiert werden soll, an. Diese Angaben sind nicht final und können später in der Datei jederzeit angepasst werden. Nach dem Klicken des Bestätigungsbuttons öffnet sich in RStudio Ihr erstes R Markdown Dokument. Durch das anschließende Drücken auf "Knit PDF", erfolgt die Konvertierung in eine PDF-Datei.
4. R Markdown - Der Aufbau
4.1 Der YAML-Header
Grundsätzlich steht am Anfang des R Markdown-Dokuments der sogenannte YAML-Header (Yet Another Markdown Language). Dieser dient der Festlegung von Metainformationen (Titel, Autor, Datum, Ausgabeformat, etc.) und ist abgetrennt durch zwei ---. Je nach Ausgabeformat können hier noch weitere Optionen angegeben werden, beispielsweise die Schriftart, die Schriftgröße oder der Zeilenabstand.
4.2 Freitext in Markdown
Zum Schreiben von Text wird die einfache Aufzeichnungssprache Markdown (daher auch der Name) verwendet. Diese wurde mit den Grundgedanken konzipiert, so einfach lesbar und schreibbar wie möglich zu sein. Dementsprechend lässt sich der Text schnell und unkompliziert mittels bestimmter Symbole formatieren. Die wichtigsten Formatierungsoptionen sind in der folgenden Tabelle dargestellt:
4.3 Mathematische Formeln
Mathematische Formeln lassen sich in R Markdown unkompliziert in Freitext einbinden, indem Sie jeweils von einem Dollar-Zeichen umrandet werden. Mit zwei Dollar-Zeichen am Anfang und Ende wird die Formel zentriert in einer neuen Zeile dargestellt. Die Formeln selbst werden in LaTeX-Code geschrieben. Ausführliche Informationen dazu finden Sie hier.
4.4 Code Chunks
In der obigen Abbildung ist zu erkennen, dass Code dem R Markdown Dokument in speziellen Blöcken hinzugefügt wird. Ein Block wird durch ```{r} (und einem optionalen Namen hinter r) eingeleitet und abschließend durch ``` beendet. Alles innerhalb eines Blocks (“Chunks”) wird als R-Code interpretiert. Ein Block kann schnell mit Hilfe der Tastenkombination Strg/Cmd + Alt + I erstellt werden.
Beim Drücken auf den den Button "Knit PDF" wird standardmäßig sowohl der R Code als auch der dazugehörige Output angezeigt. Fehlermeldungen werden dagegen nicht im PDF-Dokument angezeigt. Für den Code-Block stehen zahlreiche Anzeigeoptionen zur Verfügung, welche in ```{r} nach dem r kommagetrennt anzugeben sind (siehe obige Abbildung).
Die beiden letzten Optionen sind wichtig, falls mit Hilfe des R Codes Grafiken erzeugt werden sollen. Für die Darstellung von Tabellen ist es empfehlenswert, sich die Funktion kable( ) aus dem R-Paket knitr näher anzuschauen.
Weitere Informationen zu R Markdown finden Sie beispielsweise hier. Wir hoffen, dass Ihnen diese Anleitung bei der Dokumentation Ihrer statistischen Projekte weiterhilft.
Sollten Sie Probleme mit R, R Markdown oder der Statistik haben, dann zögern Sie nicht uns zu kontaktieren. Unser Team an Freelancern verfügt über langjährige Erfahrung auf dem Gebiet der datengetriebenen Arbeit. Wir beraten Sie gerne bei Ihrem statistischen Problem. Darüber hinaus können Sie bei uns auch statistische Auswertungen bestellen (inkl. Dokumentation). Gerne bieten wir Ihnen hierfür ein kostenloses und unverbindliches Erstgespräch mit einem unserer Experten an. Sie können uns jederzeit per E-Mail oder Telefon (siehe unten rechts) erreichen.