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
0
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
2
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
2
Code is elegant (not required, but a bonus)
Bottom Line
30
10
Postives:
Some nice figures!
Much better than your first submission, more complete.
Needs work:
__Anaylsis_Penguins.R__
Your Analysis_Penguins.R script loads a bunch of packages that you donʻt actually use. You only use skimr and lattice.
Code is clean, but there are no comments to explain the code. Need more explanation and code documentation.
Your Species names are not clean! You should only have 3 species, not 9.
Do not resave your data again. And especially not into the CODE Folder! Code goes in Code, data goes in Data.
Each piece of information (file, lines of code, scripts) should exist in only one copy in your repo. It hsould not be repeated or duplicated. This makes the code harder to maintain, allows errors to creep in, and reduces repeatability of your project.
Why are you not saving any of your figures or tables? How are they going to appear in your Manucript if you donʻt produce them?
Manuscript.qmd
Figures saved in Products/Manuscript/Manuscript_files are not explicitly produced in any script.
This is the wrong strategy - processing and analysis scripts are run only once, in their respecrive folders. The figures should be produced in those files. Not here. These .R scripts should not be here.
This analysis script has diverged from the analysis script in the code folder! It adds more packages that you aslo donʻt use. Why?
If I delete the Manucript_files, the Manuscript.qmd does not run without error. This means that you have work here that is not created through the scripts and quarto files.
Overall:
Your code design deviates from what is described in your READMEs.
There are some serious orgainziational issues. While this is better than Project 1, I am not sure you completely understand how these components are supposed to work together.
Remember to follow the principles of reproducible reserach. Do not make multiple copies of anything, ever.
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.Postives:
Some nice figures! Much better than your first submission, more complete.
Needs work:
__Anaylsis_Penguins.R__
Your Analysis_Penguins.R script loads a bunch of packages that you donʻt actually use. You only use skimr and lattice.
Code is clean, but there are no comments to explain the code. Need more explanation and code documentation.
Your Species names are not clean! You should only have 3 species, not 9.
Do not resave your data again. And especially not into the CODE Folder! Code goes in Code, data goes in Data.
Each piece of information (file, lines of code, scripts) should exist in only one copy in your repo. It hsould not be repeated or duplicated. This makes the code harder to maintain, allows errors to creep in, and reduces repeatability of your project.
Why are you not saving any of your figures or tables? How are they going to appear in your Manucript if you donʻt produce them?
Manuscript.qmd
Figures saved in Products/Manuscript/Manuscript_files are not explicitly produced in any script.
This is the wrong strategy - processing and analysis scripts are run only once, in their respecrive folders. The figures should be produced in those files. Not here. These .R scripts should not be here.
This analysis script has diverged from the analysis script in the code folder! It adds more packages that you aslo donʻt use. Why?
If I delete the Manucript_files, the Manuscript.qmd does not run without error. This means that you have work here that is not created through the scripts and quarto files.
Overall:
Your code design deviates from what is described in your READMEs.
There are some serious orgainziational issues. While this is better than Project 1, I am not sure you completely understand how these components are supposed to work together.
Remember to follow the principles of reproducible reserach. Do not make multiple copies of anything, ever.
Make sure everything is produced from your code.