Your audience is the user, members of the general public who may want to use your data and/or code. To be useful, your code and documentation must be clear to naive users (people familiar with R, but not with this project).
Elements:
Your github repo, organized following the project template.
Your modified code, quarto, and README files, organized in the repo.
Your output files (any requested output, i.e., .csv, .html, .docx, .pdf files) in their proper places in the repo.
Criteria
Evaluation
Scoring
Comments
Right
Code runs without Error - Must be YES
0/10
10
Code produces correct output
1-5
1
Readable
Code is readable (good use of white space, etc.)
1-5
5
Code is understandable (good naming conventions, concise informative comments)
Reproducible
READMEs document project organization
1-5
1
READMEs list contents of each directory
READMEs explain the order to run the code/quarto in order to reproduce analysis
Aesthetics
Files are free of unnecessary clutter (assignment instructions, etc.)
1-5
5
Code is elegant (not required, but a bonus)
22
Very clean code, for what you had, but the main issue is that there is not very much code! The parts done outside of R are not well documented. We have no idea where these came from.
Where are your readmes? You have so much data, and no documentation.
One thing you could have done is at least plot the phylogenies in R or create the tables in R. I wish I could see more demonstration of what you learned this semester!
On the positive side, it looks like it will shape up to be a very cool paper!
Project Rubric
Your audience is the user, members of the general public who may want to use your data and/or code. To be useful, your code and documentation must be clear to naive users (people familiar with R, but not with this project).
Elements:
.csv
,.html
,.docx
,.pdf
files) in their proper places in the repo.22
Very clean code, for what you had, but the main issue is that there is not very much code! The parts done outside of R are not well documented. We have no idea where these came from.
Where are your readmes? You have so much data, and no documentation.
One thing you could have done is at least plot the phylogenies in R or create the tables in R. I wish I could see more demonstration of what you learned this semester!
On the positive side, it looks like it will shape up to be a very cool paper!