UBC-MDS / out_of_this_world

MIT License
5 stars 5 forks source link

Peer review from Santiago Rugeles Schoonewolff #67

Closed ansarusc closed 3 years ago

ansarusc commented 3 years ago

Hi classmates, my name is Santiago and I´ll be providing some feedback on your project. First of all, I wanted to mention your excellent project organization. The data is included, both in its raw and processed formats, the scripts, folders, and reports have clear names and most importantly, the commits´ names are clear and understandable.

Code

There is a 'pandoc' dependency error when I try to run the make file, although I imagine this will be corrected once the docker file is implemented.

Analysis

The data preprocessing was very well done, I support every single decision you made, as it must have been hard to clean both the shapes and the sight duration. The conclusions and findings are well presented. I understood the usage of the Dunn test once you were 95% certain that at least one shape had a different sight duration than the rest, yet the selection of the Kruskal-Wallis H is not completely clear for me.

Documentation

Overall, the scripts have good documentation explaining what is expected of each of them. Moreover, the reports are well written, with proper grammar. There are a few minor typos, but nothing that affects the general readability. The makefile png is a great addition to understand the overall workflow of the project.

Suggestions

spentelow commented 3 years ago

Thanks very much for the encouraging words and helpful review comments Santiago. We have taking your suggestions into consideration as we have updated our project and addressed the issues you identified.