Giters

jpdunc23 / stat-215-a

GitHub repo template for STAT 215A Fall 2020

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Repository for submitting labs for STAT 215A Fall 2020

Setup

Your report and code will be submitted via GitHub. The following instructions will show you how to set up your GitHub account and configure a repository so that you can submit your assignments. This workflow is shamelessly copied (with slight modifications) from Chris Paciorek and Jarod Millman's STAT243 class in 2014.

  1. Install Git on your system (https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).

  2. Sign up for GitHub (https://github.com/).

  3. Optional: Go to https://education.github.com/students and sign up for the student pack (used to be required to get unlimited private repositories).

Once you have completed these first steps, you are then ready to create your private GitHub repository for this class.

  1. Locally on your machine, clone my stat-215-a repository: `git clone https://github.com/jpdunc23/stat-215-a. This will create a copy of the repository on your own computer.

  2. On the GitHub website, log in and create a private remote repository called stat-215-a. Add me (jpdunc23) as a collaborator for this repository (check out settings on the repo website).

  3. Back in the terminal, set the origin of your local repository to be the remote repository that you just made. Change USERNAME below to your username. This tells git which remote repository to push your changes to when you git push (git remote set-url origin https://github.com/USERNAME/stat-215-a.git).

  4. Edit info.txt to reflect your own information.

name = "Jane Smith"
SID = "0123456789"
email = "jsmith@berkeley.edu"
github_name = "janesmith"

Now you're ready to push to your remote repository for the first time:

  1. Check git status git status. You should see a bunch of text including modified: info.txt.

  2. Add (git add info.txt) and commit (git commit -m “Updated info.txt with my own information”) your edited info.txt file

  3. Push your changes to your copy of the remote repository (git push or sometimes git push remote origin)

  4. Check that info.txt has been updated in your remote github repository by navigating to https://github.com/USERNAME/stat-215-a (change USERNAME to your username)

Submitting your projects

To submit your projects, you will need to create a subfolder in your local stat-215-a folder called lab1 (if you are submitting lab 1). Inside this folder you should have the following (exact) structure:

lab1/
  homework1.pdf
  lab1.Rmd
  lab1.pdf
  lab1_blind.Rmd
  lab1_blind.pdf
  R/
  other/

  • The source of your report (with code) will be contained in the lab1.Rmd file (lab1.Rnw is fine too).

  • The compiled version of your report will be contained in lab1.pdf.

  • You will also submit a "blind" version of each of these documents that does not include your name (lab1_blind.Rmd and lab1_blind.pdf).

  • The R/ folder will contain any extra R scripts needed to compile your report.

  • The homework.pdf file will contain your completed homework. Please do not include any irrelevant files.

Note that GitHub cannot host files more than 100 MB. If you try to push a file larger than this, GitHub will cry. This means you should avoid pushing the data to your GitHub.

When you are ready, you need to add, commit, and push the lab1/ folder.

At the time when the lab is due, we will run a script that automatically pulls all of your assignments into my local versions of your stat-215-a repositories. Please make sure to submit your labs on time. We will spend some time in a lab having everyone submit a pretend assignment so that you are all clear on what to do.

Note: this document was originally written by Rebecca Barter in Fall 2017 and edited to reflect the changes in the course.

About

GitHub repo template for STAT 215A Fall 2020