Yes, to test effect of suspension feeder diversity on algal blooms.
Is it clear what each file in the project is intended for?
The names of the files are clear but it would be helpful to write a sentence for each file in the README.Rmd
It is clear how the various files interact?
Not quite, again just adding a sentence or two for each file would help.
Is it clear what the purpose of specific sections of code?
Not always. I really appreciate the captions below plots but quick notes on what is going on to make those plots would help a lot to describe how to replicate them.
How well commented is the code on a scale of 1(no comments) to 10(very well commented).
8
How can the purposes of the project and files be improved?
Within the README file, note which scripts aim to answer each goal and work towards an objective and which present results.
Organization
Is the project organized such that you can intuit where the data,
scripts, and output files are stored?
Not yet, but I definitely can see how it will fall into place.
Approximately how much time did it take you to understand the work flow
in the project?
A bit of time. Again, just supplying a comment or two on the purpose of each file would really help.
How well defined are code chunks in the project?
Well defined. Obvious # comments to note chunks. Within .Rmd files, code chucks are spaced with comments inbetween.
How can organization be improved?
Organize files in scripts, data, and figs folders and also supply a 'road map' of sorts within the README file.
Functionality
Does the code appear to advance the purpose of the project?
Yes, meaningful creation of figures and relevant analysis.
Do the existing components of the project appear to function?
All but the beginning! Working with the .xlsx files in the beginning is super hard. Most other portions work but I was also having trouble with priceTools package but from what I can tell this is not crucial to the project and there is more info in the repo on how to handle it.
How can the author improve functionality of code?
Converting .xlsx sheets into individual .csv files would really help with running analyses. If data is modified to do analysis, you can also create a separate script for just modification and write a new modified data file to be used in another analysis script.
Specific File Comments
README.md
Supplies a great introduction to the project and objectives but noting what each individual file should be used for would really help.
All .R analysis scripts
Simplify the data loading process and just make .xlsx files into .csv files to make loading data easier.
If a package ends up not being used in the script, just remove it from the lines of code (I was having trouble installing the priceTools package)
.Rmd Scripts
comments with hashtags in R code chunks would help narrate code and explain what is going on to create plots that are discussed in figure legends
layout: page title: Code Review
General Review Checklist
Purpose
Yes, to test effect of suspension feeder diversity on algal blooms.
The names of the files are clear but it would be helpful to write a sentence for each file in the README.Rmd
Not quite, again just adding a sentence or two for each file would help.
Not always. I really appreciate the captions below plots but quick notes on what is going on to make those plots would help a lot to describe how to replicate them.
8
Within the README file, note which scripts aim to answer each goal and work towards an objective and which present results.
Organization
Not yet, but I definitely can see how it will fall into place.
A bit of time. Again, just supplying a comment or two on the purpose of each file would really help.
Well defined. Obvious # comments to note chunks. Within .Rmd files, code chucks are spaced with comments inbetween.
Organize files in scripts, data, and figs folders and also supply a 'road map' of sorts within the README file.
Functionality
Yes, meaningful creation of figures and relevant analysis.
All but the beginning! Working with the .xlsx files in the beginning is super hard. Most other portions work but I was also having trouble with priceTools package but from what I can tell this is not crucial to the project and there is more info in the repo on how to handle it.
Converting .xlsx sheets into individual .csv files would really help with running analyses. If data is modified to do analysis, you can also create a separate script for just modification and write a new modified data file to be used in another analysis script.
Specific File Comments
README.md
All .R analysis scripts
.Rmd Scripts