Konzepte des ‘Open Science’ & Einführung in R Markdown/Quarto
DS3 - Vom experimentellen Design zur
explorativen Datenanalyse & Data Mining
Universität Hamburg, IMF
Wintersemester
Lernziele
Am Ende dieser VL- und Übungseinheit werden Sie
- ein grundlegendes Verständnis der Prinzipien von Open Science, einschließlich Transparenz, Reproduzierbarkeit und Zugänglichkeit von Forschungsergebnissen haben.
- das Prinzip des Forschungskompendiums kennen und ein R Paket zur praktischen Umsetzung.
- Fähigkeiten zur nahtlosen Integration von Code und Dokumentation in wissenschaftlichen Arbeiten besitzen, um den Reproduzierbarkeitsansatz von Open Science zu unterstützen.
- die Syntax von R Markdown (und Quarto) kennen, um dynamische, reproduzierbare Dokumente im HTM-, PDF- und Word-Format erstellen zu können.
- Erweiterungspakete kennen, welche Vorlagen für z.B. R Markdown- (und Quarto)-basierte Dokumente und Abschlussarbeiten bereitstellen.
Projektmanagement in der Wissenschaft
Viele Projekte starten mit ein paar Notizen, etwas Code, einzelnen Manuskriptabschnitten und irgendwann werde diese zusammengefügt…
Projektmanagement in der Wissenschaft
Nachteil
Ein schlechter Projektentwurf gefährdet die
- Datenintegrität
- transparente Dokumentation
- Wiederaufnahme zu einem späteren Zeitpunkt
- Übertragbarkeit des Projekts an andere
- Reproduzierbarkeit
Reproduzierbarkeit
Reproduzierbarkeit in der Wissenschaft | 2012
Reproduzierbarkeit in der Wissenschaft | immer noch aktuell
Eine Nature Umfrage in 2016 | >1500 Forscher befragt
Wozu Reproduzierbarkeit?
Reproducibility has the potential to serve as a minimum standard for judging scientific claims when full independent replication of a study is not possible. | Roger D. Peng (2011)
Daten- und Codemanagement
Datenmanagement | Chaos
Machen Sie sich klar, …
- Sie werden mit mehreren Dateien arbeiten.
- es können gaaanz viele sein.
- die Dateien werden sich über die Zeit ändern.
- die Dateien werden in Beziehung zueinanderstehen.
→ es wird also kompliziert!
Datenmanagement | Lösung
Die richtige Wahl des Dateinamens sollte beinhalten
- was es ist,
- warum es existiert und
- wie es in Beziehung steht.
Datenmanagement | Dateinamen
Schlecht
meinabstract.docx
Max’s Dateiname verwendet Leerzeichen und Zeichensetzung.xlsx
Abbildung 1.png
Abb 2.png
JW7d^(2sl/niemalsdiesedateilöschen*.txt
Gut
2020-06-26_Abstract-fuer-paper1.docx
max-dateinamen-werden-besser.xlsx
abb01_scatterplot-vortrag-length-vs-weight.png
fig02_histogram-talk-attendance.png
1986-01-28_rohdaten_ctd_alkor.txt
Das Forschungskompendium
Das Forschungskompendium | Ein Konzept seit 2004
For various reasons, it is important, if not essential, to integrate the computations and code used in data analyses, methodological descriptions, simulations, etc. with the documents that describe and rely on them. | Gentleman and Temple Lang (2004)
Aber wie kommen wir nun von hier…
Grafik von Karthik Ram: rstudio::conf 2019 Vortrag
… nach hier?
Grafik von Karthik Ram: rstudio::conf 2019 Vortrag
Forschungskompendium | Ordnerstruktur
Kleine Kompendia
Medium Kompendia
Große Kompendia
R Paket SCIproj
- Ein R-Paket für die Initialisierung und Organisation eines wissenschaftlichen Projekts nach den Richtlinien der reproduzierbaren Forschung.
- SCIproj bietet die Funktion
create_proj(), die ein neues Projekt als R-Paket mit einer leicht modifizierten Ordnerstruktur erstellt:
Kommunikationstools in R:
R Markdown vs. Quarto
Von R zum finalen Bericht
Wie kann man aus R heraus Ergebnisse in verschiedensten Ausgabeformaten präsentieren?
Von R zum finalen Bericht mithilfe von
- Das Paket ‘rmarkdown’ wird mit RStudio automatisch installiert.
- Quarto muss ggfs. seperat installiert werden: https://quarto.org/docs/download/
- In R Markdown- und Quarto-Dokumenten kann die Markup-Sprache Markdown mit R/Python/SQL/.. Input und Output kombiniert werden:
- verweben z.B. Abbildungen und Tabellen mit Text zu einem Bericht, Präsentationen oder Webseiten → vollständig reproduzierbare Dokumente
- Vorteil von R Markdown:
- seit langem etabliert mit breiter Palette von Erweiterungen und Vorlagen (blogdown, bookdown, posterdown)
- einfacher Wechsel von R Notebooks zu R Markdown Dokumenten
- Vorteil Quarto:
- flexibler (mehr Programmiersprachen, Integration mit mehr IDEs)
- ansprechendere Standardlayouts und mehr Optionen
- hilfreiche Webseite
Quarto ist die nächste Generation von RMarkdown.
Wie funktioniert das?
Verschiedene Prozesse werden in einer einzigen ‘render’ Funktion gekoppelt:
Basierend auf dem R Markdown Cheatsheet (unter CC-BY-SA Lizenz)
Wie wird eine .Rmd-Datei erstellt?
Wahl des Ausgabeformat
Struktur einer .Rmd Datei
Übersetzung in das Ausgabeformat
Bei ‘Preview in Viewer Pane’ erscheint die Vorschau für HTML-Dokumente direkt in RStudio.
Vom R Notebook zu R Markdown
Das Standardlayout ist allerdings etwas schlicht.
Markdown Syntax
R Markdown Cheatsheet
Hilfreiche Dokumente: Cheatsheet und Reference Guide
Quarto: Ein System für alle Formate
Quarto installieren
Lokal (eigener Rechner)
- Quarto muss einmalig installiert werden:
quarto.org/docs/get-started - Installation prüfen im Terminal:
quarto --version
R-Server
- Quarto ist bereits installiert
- Es kann direkt losgelegt werden, es ist keine Installation nötig!
Hinweis: Neuere RStudio-Versionen bringen Quarto mit. Für die Nutzung im Terminal (z. B. quarto use template) empfiehlt sich trotzdem die separate Installation.
Quarto Cheatsheet
Download-Link: https://rstudio.github.io/cheatsheets/quarto.pdf
R Markdown/Quarto Vorlagen
Vorlagen | UHHformats Paket 1
Als Orientierungshilfe und um den Start zu erleichtern, enthalten alle Vorlagen bereits Text, Abbildungen, Tabellen, Formeln und Referenzen!
Vorlagen | UHHformats Paket 2
R Markdown- und Quarto-Vorlagen für HTML-, PDF- und Microsoft Word-Ausgabeformate, welche auf das Design der Universität Hamburg zugeschnitten sind:
| Vorlage | R-Markdown-Funktion | Quarto-Template |
|---|---|---|
| HTML-Dokument | html_doc() |
html_doc |
| Einfaches PDF-Dokument | pdf_doc() |
pdf_doc |
| PDF-Bericht | pdf_report() |
pdf_report |
| PDF-Spickzettel | pdf_cheatsheet() |
pdf_cheatsheet |
| Word-Dokument | word_doc() |
word_doc |
Vorlagen | UHHformats Paket 3
R Markdown Vorlagen
Quarto Vorlagen
Verwende create_quarto_doc(), um ein Quarto-Projekt einzurichten:
# HTML-Dokument mit Standard Helvetica Font
UHHformats::create_quarto_doc(
dirname = "mein_html",
template = "html_doc"
)
# Word-Dokument mit UHH Font
UHHformats::create_quarto_doc(
dirname = "mein_pdf",
template = "pdf_doc",
font = "TheSansUHH"
)Vorlage für Bachelor- und Masterarbeit | 1
Das UHHthesis Paket
Erstellt eine Bookdown-Projektstruktur mit deutschen oder englischen PDF- und Word-Arbeitsvorlagen der UHH, die den Einreichungsstandards der MIN-Fakultät für Bachelor- und Masterarbeiten entsprechen.
Auch hier enthalten alle Vorlagen bereits Text, Abbildungen, Tabellen, Formeln und Referenzen als Starthilfe!
Vorlage für Bachelor- und Masterarbeit | 2
Das UHHthesis Paket
Live-Demo in R
Fragen..??
Total konfus?
Hilfreiche Webseiten, Bücher, Videos…
- R Markdown
- Offizielle Website: [https://rmarkdown.rstudio.com](https://rmarkdown.rstudio.com
- Tutorial:https://rmarkdown.rstudio.com/lesson-1.html
- Cheatsheet:
- Um tiefer einzutauchen lohnt sich ein Blick in das umfangreiche Onlinebuch R Markdown: The Definitive Guide von den Entwicklern des rmarkdown Pakets.
- Quarto
- Offizielle Website: https://quarto.org
- Posit Website: https://rstudio.github.io/cheatsheets/html/quarto.html
- Posit Tutorial Video (~25min)
- Cheatsheet: https://rstudio.github.io/cheatsheets/quarto.pdf
Bei weiteren Fragen: saskia.otto(at)uni-hamburg.de
Diese Arbeit is lizenziert unter einer Creative Commons Attribution-ShareAlike 4.0 International License mit Ausnahme der entliehenen und mit Quellenangabe versehenen Abbildungen.