05-github.knit

# gradetools **+** GitHub

---

## Outline for this part

- Why use GitHub for a course

- End-to-end GitHub course + gradetools:

- Setting up a class on GitHub

- Distributing work to students

--
  
  - Collecting students' work
  
--

- Grading
  
--

- Distributing feedback to students

---

## Outline for this part

- Why use GitHub for a course

- End-to-end GitHub course + gradetools:

- Setting up a class on GitHub

- Distributing work to students

- Collecting students' work
  
  - **Grading**
  
  - **Distributing feedback to students**
]

]

---
class:  middle

## Terminology <sup>1</sup>
.footnote[[1] based on GitHub Docs]

**GitHub repository (repo)** - A folder/space on GitHub that contains all of a project's files and each file's revision history.

**GitHub issue** - ways to plan work, track issues, and discuss projects goals.

**GitHub push** - action that results in changes made to repo on your laptop to be reflected online on GitHub (i.e. repo --> GitHub)

**GitHub pull** - action that results in changes made to repo online on GitHub to be reflected on your laptop (i.e. GitHub --> repo)

---

## Why use GitHub for a course?

- reproducibility, version control, collaboration

- students can learn GitHub _by using it_

- we can easily share individualized feedback with students

- package [ghclass](https://rundel.github.io/ghclass/)<sup>1</sup> makes it easy to manage courses on GitHub using R
.footnote[[1] by Colin Rundel and Mine Cetinkaya-Rundel]

---

## GitHub for a course?

Our favorite way:

- One **GitHub _organization_** per course

(NOT GitHub _classroom_)

]

]

---

## GitHub for a course?

Our favorite way:

- One repo per student, per week or assignment

]

]

---

## GitHub for a course?

Our favorite way:

- Quizzes and homework distributed and submitted in the repo

]

]

---

## Github for class + gradetools for grades

- 1.1 Create a new GitHub organization
- 1.2 Create one repo for your week 1 assignments

With **ghclass**:

- 1.3 Invite students to your organization

]

- 2.1 Add an assignment to the week 1 repo 
- 2.2 Automatically create a week 1 repo for each student
]

- 3.1 Collect students' work

With **gradetools**:

- 3.2 Take notes of issues while grading

- 3.3 Create issues in students (or team) repos

- 3.4 Push feedback files

]
]

---

## 1. Class setup: GitHub

.pull-left2[
1.1 Create a new [GitHub organization](https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch).

]

]

---

## 1. Class setup: GitHub

1.1 Create a new [GitHub organization](https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)

---

## 1. Class setup: GitHub

1.1 Create a new [GitHub organization](https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)

---

## 1. Class setup: GitHub

1.1 Create a new [GitHub organization](https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)

---

## 1. Class setup: GitHub

1.1 Create a new [GitHub organization](https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)

---

## 1. Class setup: GitHub

1.1 Create a new [GitHub organization](https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)

---

## 1. Class setup: GitHub

1.2 Create a repo for week 1 assignments in your organization   
(e.g. week01-data-viz)

---

## 1. Class setup: ghclass <sup>1</sup>
.footnote[[1] Much more info on [ghclass website](https://rundel.github.io/ghclass/articles/ghclass.html#structuring-your-class-on-github)]

Install and load <a href="https://rundel.github.io/ghclass/">ghclass</a>.

```r
install.packages("ghclass")
library(ghclass)
```

---

## 1. Class setup: ghclass <sup>1</sup><sup>,2</sup>
.footnote[[1] Much more info on [ghclass website](https://rundel.github.io/ghclass/articles/ghclass.html#structuring-your-class-on-github); [2] Prerequisites: GitHub token setup]

1.3 Invite students to the organization

```r
# Invite students to the organization using ghclass
org_invite(org = "example-course-federicazoe", 
           user = c("CatalinaMedina", "felipe-jones"))
```

```r
#> ✓ Invited user "CatalinaMedina" to org "example-course-federicazoe".
#> ✓ Invited user "felipe-jones" to org "example-course-federicazoe".
```

---

## 2. Assign work: ghclass

2.1 Prepare template repo for one assignment: 
  - Add assignment to this repo

```r
repo_add_file(
  org_repos("example-course-federicazoe","week01-data-viz"),
  message = "Add quiz on data visualization",
  file = here::here("demonstration-materials/github-demo/quiz01-data-viz.Rmd")
)
```

```r
#> ✓ Added file "quiz01-data-viz.Rmd" to repo "example-course-federicazoe/week01-data-viz".
```
---

## 2. Assign work: ghclass

2.1 Prepare template repo for one assignment: 
  - Set this repo as a template:

```r
repo_set_template("example-course-federicazoe/week01-data-viz")
```

```r
#> ✓ Changed the template status of repo "example-course-federicazoe/week01-data-viz" to TRUE.
```

---

## 2. Assign work: ghclass

2.2 Distribute assignment to students:

```r
org_create_assignment(
  org = "example-course-federicazoe",
  user = c("CatalinaMedina", "felipe-jones"),
  repo = paste0("week01-data-viz-", c("CatalinaMedina", "felipe-jones")),
  source_repo = "example-course-federicazoe/week01-data-viz",
  private = TRUE
)
```

```r
#> ✔ Mirrored repo "example-course-federicazoe/week01-data-viz" to repo "example-course-federicazoe/week01-data-viz-CatalinaMedina".
#> ✔ Mirrored repo "example-course-federicazoe/week01-data-viz" to repo "example-course-federicazoe/week01-data-viz-felipe-jones".
#> ✔ User "CatalinaMedina" given "push" access to repo "example-course-federicazoe/week01-data-viz-CatalinaMedina"
#> ✔ User "felipe-jones" given "push" access to repo "example-course-federicazoe/week01-data-viz-felipe-jones"
```

---

## 3. Grading: ghclass

3.1 Collect students' work

```r
local_repo_clone(
  repo = org_repos("example-course-federicazoe", "week01-data-viz"),
  local_path = "demonstration-materials/github-demo/week01-data-viz"
)
```

```r
#> ✓ Cloned "example-course-federicazoe/week01-data-viz".
#> ✔ Cloned "example-course-federicazoe/week01-data-viz-CatalinaMedina".
#> ✔ Cloned "example-course-federicazoe/week01-data-viz-felipe-jones".
```

---

## 3. Grading: gradetools

3.2 Take notes of issues while grading

```r
*assist_advanced_grading(
  rubric_path,
  roster_path,
  grading_progress_log_path,
  final_grade_sheet_path,
  example_assignment_path,
  example_feedback_path,
  example_student_identifier,
*  github_issues = TRUE
)
```

---

## 3. Grading: gradetools

3.2 Take notes of issues while grading

```r
assist_advanced_grading(
*  rubric_path,
*  roster_path,
*  grading_progress_log_path,
*  final_grade_sheet_path,
*  example_assignment_path,
*  example_feedback_path,
*  example_student_identifier,
  github_issues = TRUE
)
```

Note: the other arguments are the same as before.

---

## 3. Grading: gradetools

3.2 Take notes of issues while grading

]

]

---

## 3. Grading: gradetools

3.2 Take notes of issues while grading

]

]

---

## 3. Grading: gradetools

3.2 Take notes of issues while grading

3.3 Create issues in students (or team) repos

]

]

---

## 3. Grading: gradetools

3.2 Take notes of issues while grading

3.3 Create issues in students (or team) repos

3.4 Push feedback files

]

]

---

## 3. Grading: gradetools