Eigenschaften von Vignettes und Artikeln

Auf einer Data-Science-Konferenz triffst du eine alte Freundin bzw. einen alten Freund. Sie sind neu in der R-Paketentwicklung, haben aber viele Artikel in renommierten Fachzeitschriften veröffentlicht. Sie haben gerade ihr erstes Paket erstellt, das einen neuen von ihnen entwickelten Algorithmus unterstützt. Um ihnen beim Aufbau der Dokumentation zu helfen, erkläre ihnen die Unterschiede zwischen R-Paket-Vignettes und Artikeln.

Welche der folgenden Aussagen sind richtig?

Diese Übung ist Teil des Kurses

<Kurs>R-Pakete entwickeln</Kurs>

Interaktive praktische Übung

Verwandle Theorie mit einer unserer interaktiven Übungen in die Praxis

Diese Übung ist Teil des Kurses

<Kurs>R-Pakete entwickeln</Kurs>

Mittlere SchwierigkeitSchwierigkeitsgrad

4.8+

Kurs kostenlos starten

Steige ein in die Grundlagen des Aufbaus von R-Paketen: von der Architektur über die wichtigen Verzeichnisse R und man bis zur Bedeutung der Dateien DESCRIPTION und NAMESPACE. Arbeite praktisch mit dem Paket usethis, indem du ein eigenes Paketskelett erstellst und Daten einbindest. Stärke deine Fähigkeiten beim Schreiben von R-Funktionen, lerne Best Practices für die Paketentwicklung kennen und speichere Funktionen sicher in Dateien. Zum Schluss installierst du dein Paket lokal mit devtools.

Exercise 1: Bestandteile eines R-Pakets Exercise 2: Wahrheiten über R-Pakete Exercise 3: Was wird in allen R-Paketen benötigt?Exercise 4: Erforderliche Paketkomponenten Exercise 5: Daten und R-Markdown-Vorlage in einem R-Paket Exercise 6: Erstelle ein R-Paket Exercise 7: Daten zum R-Paket hinzufügen Exercise 8: Erstelle eine R Markdown-Vorlagendatei für ein R-Paket Exercise 9: Layout der R-Markdown-Vorlagendatei Exercise 10: Paketfunktionen erstellen Exercise 11: R-Funktion zum Umrechnen von Distanzen Exercise 12: Installiere das R-Paket und probiere es aus

Erfahre, warum sich Pakete gegenüber Skripten lohnen, und wie sie sich auf Codeorganisation, Reproduzierbarkeit, Zusammenarbeit und Teilen auswirken. Entdecke Strategien, wie du Code und Funktionen im R-Verzeichnis sinnvoll strukturierst, und wähle einen passenden Namen sowie eine Lizenz für dein Paket. Abschließend lernst du, wie du CRAN-Paketabhängigkeiten verwaltest.

Exercise 1: Mehr zur Paketstruktur Exercise 2: Packages und Skripte vergleichen Exercise 3: Deinen Paketnamen prüfen Exercise 4: Eine passende Lizenz für dein Paket auswählen Exercise 5: Paket-Build Exercise 6: Eine neue Funktion zum Paket hinzufügen und testen Exercise 7: Fehler mit load_all() debuggen Exercise 8: Unterschiede zwischen check()-Fehlern, Warnungen und Hinweisen Exercise 9: Paketabhängigkeiten Exercise 10: Arten von R-Paketabhängigkeiten Exercise 11: Paketabhängigkeiten festlegen Exercise 12: Weitere Paketabhängigkeiten festlegen

Nutze die Kraft von Beispielen in der Dokumentation, indem du Funktionsbeispiele mit roxygen2 erstellst. Verstehe, wie Beispiele das Verhalten einer Funktion klären, und identifiziere die Schlüsselelemente einer gut dokumentierten R-Funktion. Erkunde den Zweck von Vignetten in der R-Paketdokumentation und lerne Best Practices für ansprechende Vignetten kennen, einschließlich der Bewertung von Inhalt und Qualität anhand von Metadaten.

Exercise 1: Hilfedateien mit R-Paketen Exercise 2: Reihenfolge der Komponenten einer Hilfedatei Exercise 3: Exportierte und nicht exportierte Funktionen Exercise 4: Dokumentation mit roxygen2 Exercise 5: Einstiege für Funktionsdokumentation Exercise 6: Dokumentation von Funktionsargumenten Exercise 7: Rückgabewerte und Export von Funktionen Exercise 8: Hilfedatei-Dokumentation erzeugen Exercise 9: Einstieg in R-Paket-Vignetten Exercise 10: Paket-Vignetten durchsuchen Exercise 11: Eigenschaften von Vignettes und Artikeln

Aktuelle Übung

Exercise 12: R-Package-Vignetten gestalten Exercise 13: Ein Grundgerüst für eine R-Paket-Vignette erzeugen Exercise 14: Entwirf eine R-Package-Vignette Exercise 15: Paket-Vignetten bauen

Verstehe, warum Unit-Tests für die Entwicklung und Wartung von Paketen entscheidend sind, und lerne, wie du das Paket testthat für Unit-Tests einsetzt. Wandle R-Beispiele in Expectations um, um dein Wissen über Unit-Tests aufzubauen. Anschließend erfährst du, wie du deine Paketdaten dokumentierst und abschließende Checks ausführst, damit dein R-Paket robust ist.

Exercise 1: Unit-Tests Exercise 2: Vorteile von Unit-Tests Exercise 3: Richte dein Paket für Tests ein Exercise 4: Erstelle eine Testdatei Exercise 5: expect-Statements erkunden Exercise 6: Wandle ein Beispiel in einen Test um Exercise 7: Auf Warnungen und Fehler prüfen Exercise 8: Auf Ausgabe und Identität prüfen Exercise 9: Erwartungen als Unit-Tests speichern und Tests ausführen Exercise 10: Erwartungsfehler beheben Exercise 11: Teste Funktionsbeispiele ausführen Exercise 12: Alle Tests im Paket ausführen Exercise 13: Letzte Schritte Exercise 14: Schließe deine DESCRIPTION-Datei ab Exercise 15: Dokumentiere deine Daten Exercise 16: Prüfe dein R-Paket Exercise 17: Glückwunsch!