UBC-MDS / opinionated-practices-for-teaching-reproducibility

https://arxiv.org/abs/2109.13656
2 stars 0 forks source link

Implement the review feedback from the second round #53

Closed joelostblom closed 2 years ago

joelostblom commented 2 years ago

I implemented all suggestions as is except for the docker one which I made shorter and the one marked as "discretionary" since I interpreted that as "optional" and think our current wording is more illustrative. I also wrote a short review response and make a PR in the reviewer-response repo https://github.com/UBC-MDS/opinionated-practices-for-teaching-reproducibility_reviewer-response/pull/3.

Here is all the review feedback that we received in this round: Abstract: "most interesting topic" should be "most interesting topics" Abstract: add comma after "effectively guide" Abstract: consider deleting first "effectively" in final sentence Page 2, line 30: delete comma after "data science" Page 4, line 15: Perhaps "adjust" rather than "bend" (discretionary) Page 4, line 25: Change "1-3" to "one to three" Page 6, lines 8-12: perhaps you might consider elaborating on what's meant by "burning it all down": I suspect that you are proposing to have them reclone a repository because of merge conflicts. I'm not sure that this "defeats many of the purposes of version control" but it does make me wonder if it would serve as a barrier to the use of more sophisticated aspects of version control. You might consider rewording this sentence. Page 6, line 28: I'm a big fan of this paragraph. But I wonder if it might motivate why Docker is impor tant before the "Docker is an especially challenging tool". I believe that future data science workflow s will involve containerization tools of this sort and it is critical that students learn how to work o n cloud based environments. This could then segue in a new paragraph to the challenges of teaching Dock er. Page 9, line 32: "failure to adherence to reproducible practices has led" (note two changes) page 9, line 37: consider adding a ref after "to adhere to" page 9, line 42: this sentence is awkward, consider deleting "which we will outline in the next paragra ph". Or perhaps replace that sentence with a new lead to the next paragraph: "An example where failure to follow reproducible practices led to patient risk took place at Duke University in 2006 (cite B Carlson). The study involved 110 cancer patients ... page 10, line 44: "(Jon)" shouldn't appear in the citation page 13, line 9: missing period before "Here". page 17, line 46: capitalize "I"? page 18, line 11: change tilde to "around"? page 19, line 44: consider breaking sentence at "software and when": "software. When" page 22, line 25: do you have permissions to reprint the xkcd comic? page 23, line 46: I realize that the solution here is obvious, but I'm a LaTeX user. Perhaps add to the caption. "Here the reference to the gamma symbol needs to be surrounded by dollar signs to move into mathematics mode." page 25: is it possible to add URL's for Blank et al? And others (e.g., GitHub, Kelion)? NASEM shouldn't have "and others". Negerbragt is missing doi or link. Zeeberg. page 26: funky capitalization in Ebbinghaus reference Feel free to add a link for Timbers et al book. More generally, can you please review house style for references? Note that month's aren't included in dates.