BIOL548O / macdonald_andrew

data about bromeliads
MIT License
0 stars 1 forks source link

Fake example of a Peer Review #1

Open aammd opened 8 years ago

aammd commented 8 years ago

_what follows below is an example only! don't copy and paste this, but rather the relevant template from the course website, like this one_

Hello @%s,

You've been assigned to conduct the final Peer Review for @%s ! Here are the steps you should follow:

Step 1: Clone your reviewee's repo to your computer. You can do this via Rstudio, following the steps from our github lecture

Step 2: Go to the Peer Review Instructions and copy and paste the outline into a comment on this issue (or, to be safe, into your favourite text editor first, THEN paste it below when you are done!).

Step 3: Submit the marks that go with your review with this form

Thank you for your review, and for an excellent class! :smile_cat: @aammd

aammd commented 8 years ago

organization

Did your reviewee follow the directory naming convention that we are using? Was it easy to find the different R scripts?

YOUR WORDS HERE

documentation

Review the code that performs the assertions. Are the comments in the code readable? Are there any lines of code that appear without any description of what they are doing?

YOUR WORDS HERE

Assertions

what things does your reviewee test for in the assertions? Is anything missing? Suggest an improvement to their quality control

YOUR WORDS HERE

Metadata (two parts)

clear and human-readable

Is the metadata thorough? When, where and how was this work done? Do you have any questions about what the data mean?

YOUR WORDS HERE

correct and machine-readable

Choose one from below (depending on what your reviewee has done) and describe how to fix any problems you find:

YOUR WORDS HERE

Reuse your colleagues data

Do something with your reviewee's data! Write an R script that reads the data in, then does something. Don't forget to write comments!
Paste the entire R script you wrote below, inside a fenced code block
If you've made a plot, you can add that in a separate comment

YOUR CODE HERE