search

awelZH / airquality

Systematic and comprehensive air quality data compilation, analysis and visualisation for the Canton of Zurich, based on public data.
https://awelzh.github.io/airquality/
GNU Affero General Public License v3.0
0 stars 0 forks source link

Allgemeines Feedback und Anregungen #5

Closed CGRBZH closed 5 months ago

CGRBZH commented 6 months ago

Feedback:

  1. Laden von Packes besser implementieren: Entweder wie in Issue #1 beschrieben oder das Projekt in Package-Struktur bringen. Ziel sollte es auch immer sein, so wenig wie möglich Packages laden zu müssen.
  2. Spalten über ihren Namen anstatt den Index aufrufen (siehe Issue #2 )
  3. Für die STATPOP-Daten sind die Jahre aktuell hardcoded, das kann geskriptet werden.
  4. Nicht optimal, dass Funktionen derzeit den Datenimport das Data wrangling in einem machen. Die Strukturierung der Funktionen kann optimiert werden. Siehe Punkt 2 unter Anregungen. Das hängt aber auch von den Anforderungen ab.
  5. Funktionen, Funktionen, Funktionen --> @ThomasKnecht macht einen Vorschlag für ein zwei Funktionen ohne die Struktur grundlegend zu überarbeiten, bspw.: replace_no2_ps, replace_pm10 und replace_pm25 in einereplace()-Funktion umschreiben oder read_arias() umschreiben ohne dass x-mal read() / pull() gemacht wird

Anregungen:

  1. Das Projekt in die Package-Struktur bringen. Bietet viele Vorteile, u.a. werden Funktionen besser beschrieben, es gibt eine gute Übersicht über Packages und Dependencies und es lassen sich Schritte besser automatisieren.
  2. Funktionen thematisch aufteilen, bspw. in read_, prepare_, plot_ und write_-Funktionen, und diese mit klaren Funktionsbeschreibungen versehen.
  3. Ambitionen nochmals schärfen: Wer sind die Nutzer:innen? Wie automatisierbar muss oder kann es sein? Wie Fail Safe sollte es sein?
  4. Fail early besser abstützen indem Tests eingebaut werden. Bspw. nach Datenimports mit dem validate-Package oder beim Datendownload mit tryCatch() ein Fehlerhandling definieren
  5. Monitoring von automatischen Prozessen, bspw. mit GH Actions
  6. Den Bericht als pkgdown-Seite oder mit Quarto veröffentlichen?
  7. Damit die grafischen Darstellungen besser im kantonalen Corpoarte Design daher kommen, hat das STAT in statR-Package Farbpaletten im kantonalen CI/CD hinterlegt. Dürft auch ihr sehr gerne nutzen (obwohl das Wes Anderson Package schon echt cool ist 😄 )
Sintermann commented 6 months ago

teils adressiert, zur Übersicht noch offen lassen

Sintermann commented 5 months ago

teils erledigt, Rest in einzelnen Issues