quinnmoon11 / QUINN-Rclass-project

0 stars 0 forks source link

Project 1 evaluation #5

Open mbutler808 opened 1 year ago

mbutler808 commented 1 year ago

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:

  1. Your github repo, organized following the project template.
  2. Your modified code, quarto, and README files, organized in the repo.
  3. Your output files (any requested output, i.e., .csv, .html, .docx, .pdf files) in their proper places in the repo.
Criteria Evaluation Scoring Points Comments
Right Code runs without Error - Must be YES 0/10 10
Code produces correct output 0-5 5 Good, but please save data dictionary for clean data in processed data directory
Readable Code is readable (good use of white space, etc.) 0-5 2 Not very readable
Code is understandable (good naming conventions, concise informative comments) Need more editing. Will you understand this script a year from now?
Reproducible READMEs document project organization 0-5 0 missing
READMEs list contents of each directory missing
READMEs explain the order to run the code/quarto in order to reproduce analysis not clearly indicated
Aesthetics Files are free of unnecessary clutter (assignment instructions, etc.) 0-5 1 READMEs not updated for a public repo, too much clutter
Code is elegant (not required, but a bonus) nice
Bottom Line 30 18 Nice basic code. Update documentatiom for the code, with concise, informative comments. Must be be self-explanatory to the public. You can earn points back by fixing these issues for project 2.
mbutler808 commented 1 year ago

You can see an example solution here: https://github.com/mbutler808/Project-1-solution