Skip to content

Latest commit

 

History

History
70 lines (58 loc) · 6.44 KB

hw00_instructions.md

File metadata and controls

70 lines (58 loc) · 6.44 KB

Go back to STAT545A home

How to submit homework, Take 2

Filename convention

stat545a-2013-hw<XX>_<lastname-fir>.<suffix>

The XX above is 01 for homework #1, 02 for homework #2 and so on.
lastname-fir means your lastname concatenated with a dash - and the first 3 letters of your first name, all lowercase. Example: bryan-jen.
The suffix will be one of .r, .R, .rmd, .Rmd, .html.

The four files Jenny Bryan would produce for homeworks 1 and 2 might be:

  • stat545a-2013-hw01_bryan-jen.r
  • stat545a-2013-hw01_bryan-jen.html
  • stat545a-2013-hw02_bryan-jen.rmd
  • stat545a-2013-hw02_bryan-jen.html

The surest way to get a check minus is to NOT follow this convention. You can do this! You can have do overs, so don't stress out.

How to submit homework

The 3 steps that involve the outside world:

  • Publish the HTML report. Use RPubs or, if you wish and know how, publish elsewhere. One advantage of RPubs is the commenting feature, so I think that's preferred. Capture the URL. Example: a student published her homework #1 report at http://rpubs.com/parkm87/stat545a-2013-hw01_park-min
  • Publish the R script or the R Markdown file -- the "source" -- as a Gist.
    • You will need to sign in to github (?I assume?).
    • Go to https://gist.github.com.
    • In the "name this file..." box, enter the exact name of the R script or the R Markdown file, which, in turn, should conform to the convention given above.
    • Copy the entire file to the clipboard, paste into the Gist box, and click the "Create Public Gist" button.
    • Click on the "Permalink" button, in the upper right corner of the box containing your Gist (it looks like two links of a chain).
    • Capture the URL. Example: a student published her homework #1 script as a Gist and got a permalink URL of https://gist.github.com/parkm87/6541659#file-stat545a-2013-hw01_park-min-r.
  • NEW Share the links to your code. JB will usually create a share a Google doc for this purpose.