-
Notifications
You must be signed in to change notification settings - Fork 0
ToDo
Bessere Kontextualisierung der vielen files in /scripts durch sprechende Dateinamen. Die scripts sind zwar in sich meist gut strukturiert, nach außen aber erst einmal relativ nichtssagend.
Auftrennen der vorhanden scripts in allgemein nutzbare Funktionen, spezielle Funktionen und Projektanwendungen.
Im Augenblick sind alle scripts für spezialisierte Projektanwendungen entworfen. Eine erweiterte Nutzbarkeit auch für andere Anwender ergibt sich erst, wenn daraus nützliche Funktionen abstrahiert werden. Ich schlage vor, die scripts durchzuarbeiten, allgemeine Elemente auszulagern, die Projektanwendung aber aufrecht zu erhalten. Die ausgelagerten Funktionen können direkt wieder darin zur Anwendung gebracht werden. Das dient einerseits als Testmechanismus und erhält andererseits die Funktionalität der Projektscripts aufrecht.
Ich schlage einen Dateibaum folgenden Zuschnitts vor:
- scripts
- functions
- data_wrangling
- 3D_visualisation
- mapping
- ...
- projects
- GSHDL Modelling Summer School 2013
- IMODEZ
- ...
- functions
Schön, aber nicht zwingend erforderlich: Eine einheitiche, saubere Kommentarstruktur, sowie gemeinsame Konventionen, wie Code formatiert sein sollte. Da gibt es in R ja keine strikten Regeln, aber wir könnten uns auf ein paar Normen einigen, die wir dann freilich auch für den bestehenden Code umsetzen müssten.
Siehe http://r-pkgs.had.co.nz/style.html und vielleicht https://github.com/jimhester/lintr.
Die allgemein nutzbaren Funktionen sind diejenigen, die schließlich in das R-Paket eingehen werden. Sie müssen intensiv geprüft und bis zur Perfektion verbessert werden.
ArchaeoTools Übersicht Home