Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TA comments #2

Open
ChadFibke opened this issue Sep 24, 2018 · 0 comments
Open

TA comments #2

ChadFibke opened this issue Sep 24, 2018 · 0 comments

Comments

@ChadFibke
Copy link

The Reflection

  • Thanks for sharing your work flow! It seems like you are getting the hang of things!

The README

Creativity & Effort

The good 👍

  • You explored many markdown syntax options to introduce yourself! Easily went above and beyond for the introduction.

  • Go Alberta!!!

Needs work 👎

  • NA

Ease of access

The good 👍

  • Thank you for introducing yourself, AND telling readers about the other important files in this repo.

Needs work 👎

  • For next time: add a link to your hw on the assignment reflection. That way it will make it easy to find your repo.

  • For next time: try linking and listing your homework (md/rmd files) in the readme to help with navigation. That way, I can land on your repo, and click right on the files I want to see. Again, this will help with more complex repos in the future!

  • You have several unnecessary files, which will overwhelm readers as the repo grows! You can keep the these (DS_store, .gitignore, and instructions),but please make a sub folder for these in your repo. You can make a sub folder using the R misc panel (bottom right). I believe we went over this at the end of office hours or even last Thursday.

The Rmd/md

Coding style/strategy

The good 👍

  • Good use of markdown in the rmd file. The headers helped the structure, and the inline commentary helped with the flow!

  • Explored the data using summary statistics and graphs. Thanks for not blasting me with too many raw numbers! 😄

  • Used a new data set! Gapminder is fine, but real data can get hairy!

Needs work 👎

  • Next time: Make sure to use inline, and in chunk comments. I usually use inline chunks to tell the reader the general idea of that I'm doing with the code, and to interpret the output. I will then use in chunk comments to explain particular arguments in my code. This will help with the flow and will help guide readers/future-you on your through process!

  • Next time: comment on the output. Do you find anything interesting from the results? Have the results prompted you to dig deeper in a certain direction? This will help guide future-you, or other readers.

  • Add a name to each code chunk. The name should reflect the function of the code chunk. To check what I mean, go to your hw01-tsmith93/hw01_gapminder_files/figure-markdown_github/ folder and view the list of mostly unnamed chunks. This indexing/naming will help diagnose errors when knitting a file (instead of a error on line 2341234123 you will have an error with intro box plot on line 2341234123), organization of the repo, and overall ease of navigation.

Overall

  • Great work!
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant