Tom Slater's peer review: setup

[amyheather]

Peer review from @tbslater

Version Control

I like the reference to which part of the guidelines is being met (at the start).
Excellent use of pictures / diagrams throughout.

• Maybe clarify cd stands for change directory, and that the rest of the command is the path to the folder for the project.

• Under heading ‘3. Commit the changes’ it might be worth highlighting that git add . adds all changed files, in case they come across this command. Then encourage them to use e.g. git add README.md instead of git add . for more control.

Environments

‘Keeping track of your environment’ is a nice introduction.

• Typo…

• I think this subsection would benefit from a short recap / summary at the end. There was a fair bit of content (all of which was necessary and well presented) but maybe bring the key steps together so they don’t get lost in the detail.

Structuring as a Package

• Few typos…

• It might be worth a short sentence on what a docstring is. No more than a few words (as you cover it fully later), but some people may be unfamiliar with it.

• Typo...

• Maybe show this visually, as I think ```{r} could be confusing.

Code Organisation

I love this image! I think it really shows just how complicated messy code can be!

• Perhaps add some arrows and text to explain what each bit is doing. For example

• And the same for the class example too.

I like the ‘test yourself’ exercise at the end!