Für die zweite Aufgabe würde ich im Wesentlichen gerne die Punkte umsetzen, die in der ersten Aufgabe im Abschnitt "Verbesserungspotential" beschrieben wurden. Diese Änderungen hätten insbesondere den Vorteil, dass sie keinen toten Code ergeben, sondern tatsächlich sinnvolle und langfristig benötigte Verbesserungen der OpenAPC-Infrastruktur darstellen würden.
Um das Test-Framework in Python zu erweitern, sind zunächst einige Vorarbeiten erforderlich. Diese sind strenggenommen nicht Teil der Aufgabenstellung, der Vollständigkeit halber werden sie hier aber trotzdem aufgeführt.
Wie erwähnt soll das R Markdown-Template der README-Datei so abgeändert werden, dass die teilnehmenden Einrichtungen nicht mehr hardkodiert sind, sondern automatisch aus der bestehenden Institutionen-Tabelle eingefügt werden (das wird zusätzlich zur Aufgabenstellung etwas R-Code erfordern). Wichtig ist hierbei die Modellierung, um die Institutionen-Tabelle so zu erweitern, dass die bestehenden Strukturen sauber abgebildet werden können.
Wie man sieht, sind Einrichtungen ausserhalb Deutschlands einfach nur unterhalb ihrer jeweiligen Landessektion aufgelistet, was einfach abzubilden wäre. Bei deutschen Einrichtungen ist die Sache etwas komplexer: Es gibt zunächst eine Unterteilung nach
- Universitäten
- Einrichtungen der Forschungsgemeinschaften
- Andere Einrichtungen
Die Forschungsinstitute sind zusätzlich noch einmal unterteilt nach der jeweiligen Gemeinschaft. Diese Struktur ist explizit so gewünscht und muss erhalten bleiben. Es wäre also erforderlich, zunächst den Einrichtungstyp aufzunehmen (Universität/Institut/Other o.ä.) und außerdem müsste eine zusätzliche Klassifikation eingezogen werden, um eine Unterteilung nach Forschungsgemeinschaften zu ermöglichen (Diese Abstraktion würde dann ebenfalls ermöglichen, beispielsweise die Hochschulen in Universitäten und FHs zu untergliedern, falls das irgendwann gewünscht sein sollte). Beide Felder sollten auch leer bleiben dürfen (NA), um wie im Fall der anderen Länder bewusst keine Untergliederung zu generieren. Weiterhin muss natürlich der Link zum Informationsangebot aufgenommen werden (Grundlage für die eigentliche Aufgabe), außerdem wäre es sinnvoll, ein Kommentarfeld aufzunehmen, da einige der Einrichtungen mit zusätzlichen Anmerkungen annotiert sind (Beispiel). Zusammengefasst müsste die institutions.csv also um folgende Felder erweitert werden, die allesamt nicht verpflichtend sind:
- institution_type
- institution_group
- info_url
- comment
Als letzter Schritt müsste noch eine zusätzliche Mapping-Tabelle geschaffen werden, die die Länderkürzel, Einrichtungstypen und Gruppenbezeichner auflöst ("SWE": "Sweden", "WGL": "Leibniz Association" etc.)
Basierend auf den Vorarbeiten würde als eigentliche Aufgabe die Erstellung von automatisierten Tests für die Institutions-Datei anfallen. OpenAPC verwendet hierfür das Pytest-Framework, wobei es bereits ein umfassendes Modul zur Prüfung der OpenAPC-Daten gibt, aber auch kleinere Test-Sammlungen zur Überprüfung von Toolkit-Funktionen. Die Aufgabe wäre, eine zusätzliche Datei anzulegen, die Tests zur Überprüfung der Institutions-Datei enthält. Folgende Prüfungen sollten dabei mindestens stattfinden:
- Überprüfung der
info_urldurch Aufruf und Auslesen des HTTP-Status. Hier ist vermutlich Feintuning erforderlich, um die Ausführung bei langen Response-Zeiten nicht zu sehr zu verzögern, eventuell lassen sich auch mehrere Aufrufe parallelisieren. Zudem wäre es konzeptuell anzuraten, Fehlschläge nur als Warnungen und nicht alsfailauszugeben, da Nichterreichbarkeit einer URL sehr unterschiedliche Gründe haben kann. - Die Spalte
institutiongibt die Bezeichner im OpenAPC-Datensatz an. Diese sollten wechselseitig auf Vollständigkeit geprüft werden: Ist jeder Bezeichner aus dem Datensatz in der Institutions-Tabelle enthalten und umgekehrt? openapc_data_dirgibt den Pfad zum Verzeichnis an, in dem die Daten einer Einrichtung liegen. Hier sollte überprüft werden, ob das Ziel tatsächlich vorhanden ist.