Files aufräumen 🧹

[pr130]

• [ ] evaluieren welche Files gebraucht werden und sie ggf aufräumen

[selinaZitrone]

Ich bin das Projekt durchgegangen und hab mir Notitzen gemacht welche Files evtl. weg können, wie man Files umbenennen könnte usw. Die Aufräumaktion müsste allerdings jemand übernehmen bwz. überprüfen, der/die sich mit dem Projekt besser auskennt. Vielleicht @ZoeWolter ?

Hier die Notizen mit Vorschlägen/Fragen, die ich mir beim Durchsehen gemacht habe.

Naming convention

Ich finde die Namen der Files oft schwer zu lesen. Vielleicht können wir uns dafür eine Konvention überlegen? z.B. ID_name-of-file.Rmd oder ID_name_of_file.Rmd?

Ein Beispiel wäre dann:

09_grundlagenderstatistik_v2.Rmd -> 09_grundlagen-der-statistik.Rmd

File aus lernplattform.Rmd

Die Files, die gerade in lernplattform.Rmd benutzt werden, sollten konsistent benannt und die Nummerierung angepasst werden. Hier ein paar Vorschläge von mir (macht vermutlich nicht alles Sinn, da ich die Reihenfolge im Kurs nicht kenne):

Folgende Files sind im Moment in der app drin:

• 01_intro.Rmd
• 02_setup.Rmd
• 03_datenschutz_v2.Rmd -> umbenennen in 03_datenschutz.Rmd
• 04_rstudio_v2.Rmd -> umbenennen in 04_rstudio.Rmd
• 05_ersteanalyseinr.Rmd -> umbenennen in 05_erste-analyse.Rmd
• 06_datenimport.Rmd -> 06_daten-import.Rmd oder nur 06_import.Rmd
• 06_datenimport_exkursapi.Rmd -> 06_daten-import-api.Rmd
• 06_datenimport_exkurssql.Rmd -> 06_daten-import-sql.Rmd
• 07_datentransformation.Rmd -> 07_daten-transformation.Rmd oder nur 07_transformation.Rmd
• 08_datenvisualisierung.Rmd -> 08_daten-visualisierung.Rmd oder nur 08_visualisierung.Rmd

Folgende Files sind im Moment auskommentiert:

• 09_grundlagenderstatistik_v2.Rmd -> 09_grundlagen-statistik.Rmd
• 10_reports.Rmd
• 11_automatisiertereports.Rmd -> 11_reports-automatisiert.Rmd
• 12_rshiny.Rmd
• 02_datenprojekteundstrategie.Rmd -> 13_daten-projekte-und-strategie.Rmd
• 14_lernzielkontrolle.Rmd -> 14_lernziel-kontrolle
• 13_closing.Rmd -> 15_closing.Rmd
• 99_glossar.Rmd

Unbenutze Files

Files von denen ich nicht weiß ob und falls ja wofür sie gebraucht werden

Können die ins Archiv, einen anderen Unterordner (e.g. additional_material/) oder gelöscht werden?

• requirements.txt -> weg?
• karte.R -> wird nirgendwo benutzt
• karte.Rmd
• 03_datenschutz.Rmd -> Im Moment wird 03_datenschutz_v2.Rmd benutzt. Kann diese hier ins Archiv?
• 04_rstudio.Rmd -> Im Moment wird 04_rstudio_v2.Rmd benutzt. Kann diese hier ins Archiv?

Weiter Kommentare und Ideen

• archiv/ aufräumen?

  • .html files raus?
  • Untitled.Rmd files raus?
  • Readme hinzufügen?

• daten/ aufräumen?

  • Wirklich nicht mehr benötigte entweder löschen oder in archiv/daten/ verschieben
  • Nicht benötigte abbildungen/ aufräumen (nicht benutzt werden app1.png, app2.png, app6.png, 08_reports_uebung1_gallery-instruction.png, plot_ggplot.png, running.png, shiny_step3.png, sketch_app.png)
  • Beach Clean Up - Google Trends.xlsx -> Wird geschrieben ind gtrends_beachcleanup.Rmd aber nie gebraucht
  • cheat sheets/: Vielleicht besser irgendwo die Links zu den Sheets statt pdfs im Repo? geospatial/: 100_NUTS* wird nicht benutzt
  • screen_record_data_to_viz.mov wird nicht benutzt

• Warum gibt es daten/abbildungen/ und images/ und in beiden Ordnern sind Abbildungen für die Lessons?

• /uebungen

  • Konsistente Dateinamen mit den entspechenden Lektionen
  • Falls es nicht mehr benötigt Files gibt, in archiv/uebungen/ verschieben?

[ZoeWolter]

Danke @selinaZitrone!!

• Rmd-Dateien habe ich durchgeschaut, alle überflüssigen gelöscht und die relevanten einheitlich umbenannt
• requirements.txt habe ich mal drin gelassen für eine Übersicht über die Packages, die Nina geladen hatte, aber kann eigentlich weg, sobald die Packages über ein renv o.ä. geladen werden
• Cheatsheets habe ich schon mal an einem Ort sortiert, die ganzen anderen Ordner muss ich noch durchgehen
• still ongoing: bei den Dateien, bei denen ich mir nicht sicher bin, ob sie noch jemand braucht, frage ich entsprechend nach und schiebe sie vorübergehend in den Ordner tbd

[ZoeWolter]

• Bilder habe ich jetzt auch einheitlich im Order abbildungen/ abgelegt
• Beach Clean Up - Google Trends.xlsx wird verwendet in der Lektion 05_datenimport.Rmd
• aus dem Ordner Daten habe ich einiges gelöscht
• Ordner archiv ist komplett gelöscht