Homework Guidelines

Github pre-requisites

The following are pre-requisites for submitting the homework.

  • We assume you already have a Github account and you are able to push/pull into Github. If not, please read Lecture 01.

  • Claim your repository in Github - just accept your assignment invitation.

  • Install git in your local machine for your OS. Git can be obtained here.

A note on git installation on windows: If you are using a Windows laptop and your RStudio cannot link to your git account, please [download this git-bash] (https://git-for-windows.github.io/) and install it (with default settings).

README.txt

As a part of your first homework, you will also create a README.txt file and push it into your repository. For every assignment you do, you have to create a README.txt file. It could be a very simple file, but you need to make one. Assignments without README.txt will not be graded and given zero.

Naming files (after the first homework)

Throughout this course you will create R Markdown files and render it as html which you will push to your coursework repository. Your markdown files should be named with an extension “.Rmd” or “.rmd”. RStudio’s “Knit to HTML” button will compile the document for you to actual HTML and open a preview. You may want to read the chapter R Markdown in the book R for Data Science if you want to get started before we cover this in the class.

Make sure you organize your files really well and name appropriately so it is easier for us to grade. Part of the grades will go for your ability to organize files for easier access and readability.

How to submit homework?

  1. Accept your assignment in your GitHub home page. A repository will be created.

  2. Open RStudio -> New Project… -> Version Control -> Git

  3. Copy and paste the link of the repository. Choose the project desitination folder name and path.

  4. Work on your homework. Make README.txt and save it to the directory.

  5. Make sure you have saved the work in your local directory.

  6. When you hit the save icon in the RStudio editor, you will see the saved file popping up in the Git panel of RStudio, ready to be committed. In case of markdown files (from home work 2), you need to do “Knit to HTML” in RStudio editor to render the associated HTML file.

  7. The saved file should pop up in the Git pane in the environment pane. In case of knitted markdown file, you will see two files, the markdown and the html documents, ready to be committed to Git (after you knit).


  1. Check the files, write a commit message and commit the work to your Git repository.


  1. Push your work into Github.


You are done now.