Overview

We assume you’ve been keeping up with our live class activities, which have included

Due by midnight Tuesday 2017-09-19, but I highly recommend you aim to submit before class. This assignment should go smoothly, but if the computer gods do not smile upon you, we should be able to straighten things out in class or office hours.

Create a New Repo

Create a new repo on GitHub. Your homework submission will go here. Feel free to make it either public or private. Name the repository STAT545-hw01-lastname-firstname. be sure to initiate the repo with a README.

Note: You can sign up for a student account to get free private repos. If you want a private repo, but can’t get one on github, there are alternatives – just ask Vincenzo.

Edit README.md

When you first visit your new repo, you should see a screen like this. You need to edit your README.md file to welcome your visitors (you, STAT545 instructor/TAs, STAT545 peers).

If you are already familiar with GitHub, edit the README.md any way you wish.

If you are new to Git and GitHub, click on the README link in the area that looks like a file browser. Click on the pencil and make an edit. Then head down to “Commit changes”. Enter a short commit message. Then click “Commit changes”. This is how you can edit files in GitHub repository through the browser. If you are still mystified by Git(Hub), you can use this browser-based method to edit README.md until you get more comfortable with using Git locally and pushing to GitHub. However, if at all possible, we want you to pilot a more powerful workflow:

At the very least, change README.md to something like “This is the repository of Jenny Bryan,” just to prove you have been there. Practice making a link, for example, to the main STAT545 webpage.

Much better is to introduce yourself to the class; this page is private to STAT 545 but will be visible to all students and staff. Feel free to read up on Markdown and practice with some of the syntax. Put in a photo or a GIF!

Here’s a sample readme file that you can use as reference and/or inspiration, and here is the raw source. The Help menu in RStudio will bring up a Markdown Quick Reference at any time.

Add R Markdown and Markdown for Gapminder exploration

This is optional. If you are really struggling, skip it for now. But try!

Polish and extend the R Markdown document started in class on Thursday September 14. Render it to the github_document output format. Commit both the .Rmd and .md files and push them to GitHub.

Give this a decent name, such as hw01_gapminder.Rmd (which will produce a companion file, hw01_gapminder.md).

Report your process

WE REALLY CARE ABOUT THIS! DON’T SKIP IT.

Include a description of how you got the changes into README.md on GitHub.

How did it all work for the R Markdown document?

You’re encouraged to reflect on what was hard/easy, problems you solved, helpful tutorials you read, etc. Put this in your README. In a week or two, you can delete this bit.

Submit the assignment

You must do the following to submit the assignment:

  1. Add the teaching team as collaborators. Their github alias’ are:

vincenzocoia gvdr ksedivyhaley joeybernhardt mynamedaike pgonzaleze derekcho

  1. Write an issue entitled hw01 ready for grading, and tag the above teaching team. Here’s a convenient string to copy and paste to tag the team:

@vincenzocoia @gvdr @ksedivyhaley @joeybernhardt @mynamedaike @pgonzaleze @derekcho

  1. You’re done!

Rubric

Check minus: README.md says equivalent of “This is the repository of Jenny Bryan”. All work done via browser at github.com … but that’s just a guess, because student doesn’t actually say how it was done. No attempt to submit an R Markdown document exploring the Gapminder data. The homework submission issue is not named correctly, doesn’t include the SHA or a link to the work to be reviewed.

Check: something in between. Student may have failed to render to the github_document output and commit/push the resulting .md file. The homework submission issue might not be perfect, but there was a good effort.

Check plus: README.md provides a proper introduction of student to the class. It also demonstrates experimentation with 4 or more aspects of the Markdown syntax. Examples: section headers, links, bold, italic, bullet points, image embed, etc. The student describes how they got the changes into README.md. Student has submitted a well-named R Markdown document with exploration of the Gapminder dataset and the rendered markdown file. Student offers a few reflections on their GitHub workflow and their experience with Markdown. The homework submission issue follows the naming convention, includes the SHA, and there’s a link to the rendered .md for the Gapminder exploration.

Peer Review

Information about peer review for Homework 01 will go here. You’ll be messaged via Slack when this section has been updated and action is required.