STAT547-UBC-2019-20 / group05

Repository for our team project (group 05)
0 stars 3 forks source link

Milestone 2 feedback #15

Closed yuliaUU closed 4 years ago

yuliaUU commented 4 years ago

Amazing readme description! very informative, but one tiny improvement is needed:

major issue with clean script and EDA:

iciarfernandez commented 4 years ago

Hey Yulia,

Thank you for the feedback! We definitely should've worked more on the scripts, we will add the command line arguments and improve the structure before submitting the next milestone.

However, we didn't think we needed to create a function according to the milestone instructions (which you mention in your feedback) - could you please clarify this? Also, we have noticed that the grading rubric on Canvas doesn't show up task 3 at all, which was worth 10%. Please let us know!

Thanks again!

yuliaUU commented 4 years ago

Hi! Let me check.....

so from what I can gather, there are plenty of indications that you need to use it. But I re-considered your mark for those sections: as I can see you know how to do it from task 2.1 and added points

Task 3: you are totally right! I added it to the rubric! thanks for catching that .

jacobgerlofs commented 4 years ago

Thanks for all your feedback @yuliaUU For the sake of Milestone 4, Task 1 (Address peer review feedback), I've quoted below your initial comments and responded to them line-by-line.

I wasn't sure in following the Milestone 4 guidelines if we have to comment on both student peer review and TA comments - the task mentions responding to TA comments. So, for the sake of diligence, we are also responding to your issue!

Amazing readme description! very informative, but one tiny improvement is needed:

  • see example hoe to format r code in rmarkdown document, so it is separated from plain text . for example this link

Another peer reviewer has also raised this issue. I agree, the code formatting is easier to read/use. We've updated README to use this markdown formatting feature.

major issue with clean script and EDA:

  • not structured (where the doctop()?)
  • no command line arguments
  • does not take in path to the raw data or path where data will be saved
  • no function created

Yes, in working on Milestone 2 we just didn't have time to finish adding all the components of docopt. We figured it was better to have an operating script rather than one that doesn't work while half-implementing docopt and command line arguments. We have since updated all our scripts to use docopt and command line arguments!