Seminar R – Paketentwicklung, Tests und Zusammenarbeit

Seminarbeschreibung

Eigene R-Pakete schaffen einen klaren Rahmen für gemeinsam genutzte Funktionen. Das Seminar führt von einer Sammlung vorhandener Skripte zu einem installierbaren, dokumentierten und prüfbaren Paket. Dabei werden öffentliche Schnittstellen, interne Hilfsfunktionen und externe Abhängigkeiten bewusst voneinander getrennt.

Ein kleines Teamprojekt bildet den roten Faden. Änderungen werden versioniert, Tests um fachliche Grenzfälle ergänzt und Fehlermeldungen aus der Paketprüfung bearbeitet. Die kontinuierliche Integration wird anhand einer vorbereiteten Umgebung eingeübt. Im Mittelpunkt steht ein internes Paket; eine Veröffentlichung auf CRAN wird als eigener Freigabeprozess eingeordnet und ist kein zugesagtes Seminarergebnis.

Zielgruppe

R-Entwickler, Data Scientists und analytische Teams mit gemeinsam genutzten Funktionen oder wiederkehrenden Auswertungsverfahren.

Voraussetzungen

Sicheres R und Erfahrung mit eigenen Funktionen, Fehlerbehandlung und Listen. Kenntnisse entsprechend dem Seminar Fortgeschrittene Programmierung. Grundkenntnisse eines Terminals sind hilfreich; Git wird im erforderlichen Umfang eingeführt.

Lernziele

• Eine nachvollziehbare Paketstruktur mit begrenzten Schnittstellen anlegen.
• Funktionen und Beispiele mit roxygen2 dokumentieren.
• Fachliche Eigenschaften, Grenzfälle und erwartete Fehler mit testthat prüfen.
• Änderungen mit Git bearbeiten und Paketprüfungen automatisiert ausführen.

Inhaltsübersicht

1. Paketstruktur und Schnittstellen
2. Dokumentation und Beispiele
3. Automatisierte Tests
4. Paketprüfung und Abhängigkeiten
5. Git und gemeinsame Änderungen
6. Automatisierte Prüfung und Bereitstellung

Seminarinhalte

Paketstruktur und Schnittstellen

Aus Funktionen wird eine klar gegliederte, installierbare Einheit.

• DESCRIPTION, NAMESPACE und die üblichen Paketverzeichnisse einordnen.
• Mit usethis und devtools ein Paketgerüst erstellen.
• Exportierte Funktionen, interne Helfer und Abhängigkeiten bewusst festlegen.

Dokumentation und Beispiele

Die Nutzung des Pakets wird ohne Kenntnis seiner Implementierung verständlich.

• Argumente, Rückgaben und Randbedingungen mit roxygen2 beschreiben.
• Ausführbare Beispiele und eine kurze Anwendungsvignette erstellen.
• Dokumentation generieren und auf Übereinstimmung mit den Funktionen prüfen.

Automatisierte Tests

Tests sichern fachliches Verhalten und bekannte Fehlerfälle ab.

• Mit testthat Normalfälle, Grenzfälle und erwartete Fehler formulieren.
• Abhängigkeiten von Uhrzeit, Netzwerk und Zufall kontrollieren.
• Regressionstests für einen behobenen Fehler hinzufügen; fragile Detailtests vermeiden.

Paketprüfung und Abhängigkeiten

Ein installierbares Paket wird unter definierten Bedingungen geprüft.

• R CMD check ausführen und Fehler, Warnungen und Hinweise einordnen.
• Imports, Suggests und die Verwendung vollständig qualifizierter Funktionsnamen prüfen.
• Paketabhängigkeiten von einer mit renv dokumentierten Projektumgebung unterscheiden.

Git und gemeinsame Änderungen

Änderungen erhalten eine nachvollziehbare Geschichte und Prüfung.

• Commits, Branches und Zusammenführungen anhand des Beispielpakets durchführen.
• Einen überschaubaren Konflikt auflösen und die fachliche Änderung kontrollieren.
• Code-Reviews, Versionsnummern und Änderungsnotizen sinnvoll einsetzen.

Automatisierte Prüfung und Bereitstellung

Die Qualitätssicherung wird außerhalb des Entwicklerrechners wiederholbar.

• Einen vorbereiteten CI-Workflow für Installation, Tests und Paketprüfung anpassen.
• Systemabhängigkeiten und vertrauliche Konfiguration vom Quellcode trennen.
• Ein Paketarchiv erzeugen, in einer sauberen Umgebung installieren und eine interne Freigabe vorbereiten.

Praxisprojekt

1. Eine vorhandene Auswertungsfunktion in ein neues Paket überführen.
2. Die Schnittstelle dokumentieren und einen bewusst eingebauten Fehler mit einem Test aufdecken.
3. Den Fehler beheben und die Änderung in einem eigenen Git-Branch festhalten.
4. Paketprüfung und vorbereitete CI-Prüfung durchführen.
5. Das erzeugte Paket in einer getrennten Umgebung installieren und das Anwendungsbeispiel ausführen.