R Markdown

Data Reports mit Text und Code.

Author

Affiliation

Gerda Wyssen

Kognitive Psychologie, Wahrnehmung und Methodenlehre, Universität Bern

Lernziele

Erstellen eines (reproduzierbaren) Data Reports mit Datenvisualisierungen zu unserem Experiment.

In der heutigen Sitzung lernen wir die Basics, die man braucht um einen Data Report in R Markdown erstellen zu können.

• R Markdown File erstellen
• R Markdown File ausführen (knitten)
• Titel und Layout anpassen
• Text schreiben in R Markdown
• Code verwenden in R Markdown

R Markdown

R Markdown ist eine simple Markup-Sprache, die es uns ermöglicht reproduzierbare Data Reports zu erstellen. R Markdown ist praktisch, weil wir gleichzeitig Text und Code verwenden und den Output des Codes anzeigen können. Den Text können wir schreiben, ohne dass vor jede Zeile ein # gesetzt werden muss und wir können ihn formatieren. Das Skript der R Markdown Files wid geknittet und so zu einem HTML, PDF oder Word-Dokument (je nach Wahl). Wir können mit R Markdown also beispielsweise eine Text-Beschreibung, Code zum Erstellen einer Grafik und auch die erstellte Grafik kombinieren.

Man kann mit R Markdown auch Präsentationen, Webseiten, Bücher, Lebensläufe, Artikel oder Arbeiten erstellen. Hier finden Sie eine Gallerie.

R Markdown File erstellen und ausführen

Zuerst erstellen wir ein R Markdown File und schauen uns die wichtigsten Funktionen an. Wir wählen als Outputformat html.

Hands-on

• Laden Sie hier den Projektordner herunter und entzippen Sie diesen.
• Öffnen Sie das Projekt und erstellen Sie unter File > New File > R Markdown ... ein neues RMarkdown-File.
• Geben Sie einen Titel und Ihren Namen ein und wählen Sie HTMLals Output-Format
• Speichern Sie dass Dokument unter dem Namen rmarkdown_exampleab.

Weiterführende Informationen:

👉 Einführung in die Verwendung von R/RStudio/Notebooks im Rahmen des Psychologie Studiums von Andrew Ellis und Boris Mayer Einführung in R

👉 Sehr kompakte, praxisnahe Einführung in R Markdown von Danielle Navarro (Slidedeck in englisch) Einführung in R Markdown

Wenn Sie die obigen Schritte ausgeführt haben, beantworten Sie bitte folgende Fragen:

Aufgabe 1

Welches Format (Endung) hat das abgespeicherte R Markdown Skript nun in Ihrem Ordner?

Lösung 1

.Rmd für R Markdown

Knitten

Mit Knit führen wir das R Markdown Skript nun aus und erstellen so (wie vorher ausgewählt) ein html-File.

Aufgabe 2

Führen Sie das File mit Knit aus und vergleichen Sie das R Markdown Skript mit dem Output den Sie erhalten haben. Was fällt Ihnen auf?

• Was ist nicht mehr zu sehen?
• Was ist zusätzlich zu sehen?
• Was hat sich im Projekt-Ordner verändert?

Lösung 2

Nicht mehr zu sehen ist der vollständige YAML-header, ganz oben im R Markdown Skript.

Auch nicht mehr zu sehen ist die “Umrandung” des Code-Snippets.

Neu sieht man nun den Output des Codes.

Im Projektordner wurde ein .html-File erstellt. Sie können dieses öffnen, um zu schauen wie das aussieht.

YAML header

Zu Beginn des R Markdown Skripts finden Sie den YAML header. Hier werden Informationen zu Titel, Autor:Innen, Datum, Outputformat, Literaturverzeichnis und Layout festgelegt.

YAML: Yet Another Markdown Language

Das Layout kann unter themegeändert werden. Das kann beispielsweise wie folgt aussehen:

output:
  html_document:
    theme: cosmo

Achtung: Einrückungen müssen stimmen! Hier wurde das theme namens cosmo ausgewählt. Mögliche andere themessind z.B. default, cerulean, journal, flatly, darkly, readable, spacelab, united, cosmo, lumen, paper, sandstone, simplex, yeti.

Hands-on

• Geben Sie dem Dokument einen neuen Titel z.B. R Markdown Einführung

• Ändern Sie das Layout so, dass es Ihnen gefällt.

Text erstellen in R Markdown

Text kann in R Markdown Files nicht nur geschrieben, sondern auch relativ simpel formatiert werden.

👉 Hier können Sie das Cheatsheet herunterladen. Auf der rechten Seite finden Sie die Informationen für die Textformatierung.

Knitten Sie das Skript immer wieder um zu überprüfen, ob alles passt. Es empfiehlt sich anfangs häufig zu knitten, so findet man den Fehler schneller, weil man noch weiss, was man verändert hat.

Hands-on

• Löschen Sie alles bis auf den YAML-Header

• Schreiben Sie im Textbereich eine Überschrift für ein Kapitel, ein Unterkapitel und normalen Text.

• Schreiben Sie im Text etwas kursiv und etwas fett.

• Erstellen Sie im Textbereich eine Liste mit 3 Punkten.

• Fügen Sie die Formel a^2 + b^2 = c^2 in den Text ein. Verwenden Sie dafür zwei Dollarzeichen am Anfang und am Ende. Was passiert? Schreiben Sie alpha innerhalb von Dollarzeichen, was passiert?

• Fügen Sie einen Link ein, knitten Sie das File und schauen Sie ob der Link funktioniert. Können Sie einen Link nur mit einem unterstrichenen Text anzeigen, so dass die Linkadresse nicht sichtbar ist?

• Fügen Sie ein Bild ein. Sie können beispielsweise das Bild logo_landing.png aus dem Projektordner nutzen oder ein eigenes verwenden.

Code erstellen in R Markdown

Nun erstellen wir Code. Zuerst fügen wir ein Code-Chunk ein, darin muss der Code stehen um ausgeführt zu werden. Dies können Sie unter Code > Insert Chunk tun oder Ctrl+Alt+ I drücken. Code-Chunks werden mit ``` begonnen und beendet. In den geschweiften Klammern steht r, das bedeutet das der Code in der Sprache R geschrieben ist. In dieser Klammer können wir dem Code-Chunk einen Namen geben und bestimmen, ob der Code ausgeführt und angezeigt wird, und ob der Output des Codes angezeigt werden soll.

Sie können mit dem grünen Pfeil den Code-Chunk ausführen. Aber auch einzelne Zeilen können ausgeführt werden, genau so wie in einem .R- Skript.

Hands-on

• Erstellen Sie einen Code-Chunk, der ausgeführt, aber nicht angezeigt wird. Erstellen Sie eine Variable mit dem Namen numbers, die 10 Zahlen enthält.

• Erstellen Sie ein Code-Chunk, der ausgeführt wird und dessen Output angezeigt wird. Berechnen Sie in diesem Chunk den Mittelwert und die Standardabweichung von numbers.

👉 Schauen Sie dafür nochmals im Cheatsheet nach oder drücken Sie auf das Zahnrädchen-Symbol beim Code-Chunk.

• Erstellen Sie einen Plot mit plot(numbers).

• Knitten Sie das File, um zu überprüfen, ob alles funktioniert

Reuse

https://creativecommons.org/licenses/by/4.0/

Citation

BibTeX citation:

@online{wyssen2023,
  author = {Gerda Wyssen},
  title = {R {Markdown}},
  date = {2023-04-02},
  url = {https://kogpsy.github.io/neuroscicomplabFS23//rmarkdown.html},
  langid = {en}
}

For attribution, please cite this work as:

Gerda Wyssen. 2023. “R Markdown.” April 2, 2023. https://kogpsy.github.io/neuroscicomplabFS23//rmarkdown.html.