Literal Programming (a.k.a. Reproducible Reporting) mit quarto

Im vorherigen Kapiteln hat man gesehen, dass ein Kommandozeilenprogramm ist, das in einem Terminal genutzt oder in einer IDE wie RStudio ausgeführt werden kann. Doch oft reicht es nicht aus, nur Code zu schreiben – man will seine Analysen verständlich dokumentieren, reproduzierbar machen und in einer lesbaren Form präsentieren. Dazu dient das sogenannte Literate Programming (Knuth, 1992) ins Spiel. Dabei werden Code und erklärender Text in einem einzigen Dokument kombiniert. Statt reinen Code zu schreiben, dokumentiert man den Gedankenprozess hinter der Analyse, indem Code-Blöcke mit Fließtext, Formeln und Visualisierungen gemischt werden.

Mit quarto, einem modernen Dokumentations- und Publishing-Framework, kann das leicht umgesetzt werden. quarto ermöglicht es, Code, Ergebnisse und erklärenden Text in einem einzigen .qmd-Dokument zu verfassen und in verschiedene Formate zu rendern, z. B.:

quarto bietet in einer IDE wie RStudio grafische Tools, um:

Ein neues Quarto-Dokument erstellen

  • RStudio öffnen
  • Datei → Neues Datei → Quarto Document…
  • Gewünschte Format (z. B. HTML, PDF, Word) wählen (empfehlenswert ist zu Beginn .html)
  • Namen für die Datei eingeben und als mein_report.qmd speichern.
  • Auf das Render-Symbol klicken. quarto führt dann den R-Code aus und fügt In- wie Output mit dem gerenderten Markdown zu einem Dokument zusammen

Beispielergebnis

.qmd-File und gerenderte Ergebnisse

Übung 1

Laden Sie dieses zip-File herunter, dekomprimieren Sie es und öffnen Sie das .Rproj-File. Nach Installation der notwendigen Pakete können Sie mit dem Render-Button den im Abschnitt zuvor dargestellten Report erzeugen.

Literatur

Knuth, D. E. (1992). Literate Programming. Stanford, CA: Center for the Study of Language and Information.