jmausolf
commented
7 years ago Evaluation HW-01 for Poh Yu Quan
| Topic | Excellent | Satisfactory | Needs Work |
|---|---|---|---|
| Coding style | x | ||
| Coding strategy | x | ||
| Presentation: graphs | |||
| Presentation: tables | |||
| Achievement, creativity | x | ||
| Ease of access | x |
Remarks:
- Nice attempt of adding a .gitignore. There is actually a default one for R files that you can get when creating a new repo. You tried to ignore the .Rproj, but committed it anyway. Two things:
- Commit the .gitignore before other commits
- Pay attention to the backslash:
.Rproj.uservs..Rproj.user/ - If you are using bash, you can run the command
git statusto check what files you have added before committing them. This is best practice, especially at first.
Full R .gitignore file
# History files
.Rhistory
.Rapp.history
# Session Data files
.RData
# Example code in package build process
*-Ex.R
# Output files from R CMD build
/*.tar.gz
# Output files from R CMD check
/*.Rcheck/
# RStudio files
.Rproj.user/
# produced vignettes
vignettes/*.html
vignettes/*.pdf
# OAuth2 token, see https://github.com/hadley/httr/releases/tag/v0.3
.httr-oauth
# knitr and R markdown default cache directories
/*_cache/
/cache/
# Temporary files created by R markdown
*.utf8.md
*.knit.md- Otherwise, you effectively used five of the five style elements, italics, headers, list, links, and photo. Good job.
- Try to make different and more descriptive (but short) git commit messages (versus
modified READMEfour times). - Proved you can do the workflow.
How I got my changes onto GitHub: First I forked the HW repository, next I cloned the forked repository onto my computer using RStudio. I created a new project in RStudio using version control (Git) and pasted the URL for my forked repository. I modified the README.md file in RStudio using Markdown Syntax as indicated by Github (https://guides.github.com/features/mastering-markdown/). I committed my changes and added a message "modified README" to indicate my changes. I pulled from GitHub using the "Git" tab in RStudio to update my local repository. I pushed my changes to GitHub through RStudio in the same "Git" tab as before. Finally I made a pull request to merge the forked branch with the master.
Reflections: The process of cloning a repository and making local changes before committing it and pushing it was fairly straight forward as I referenced the steps indicated through the CFSS "General Homework Guidelines" (http://cfss.uchicago.edu/hw00_homework_guidelines.html#homework_workflow). Although I had previously used a different command interface (cygwin), it took some getting used to in order to learn how to perform the similar commands on RStudio. I was able to Google how to preview R Markdown documents in HTML on RStudio which allowed me to preview my HTML without the need to commit and push my changes onto GitHub. There are clearly other formatting syntax that I will need to learn in order to make my Markdown document more aesthetically pleasing but overall the process of making changes and pushing and pulling onto GitHub was fairly simple and without much problems.