NHS-R Community Introduction to GitHub webinar

<div>
<style type="text/css">.xaringan-extra-logo {
width: 300px;
height: 200px;
z-index: 0;
background-image: url(img/nottshc.PNG);
background-size: contain;
background-repeat: no-repeat;
position: absolute;
top:0em;right:1em;
}
</style>
<script>(function () {
  let tries = 0
  function addLogo () {
    if (typeof slideshow === 'undefined') {
      tries += 1
      if (tries < 10) {
        setTimeout(addLogo, 100)
      }
    } else {
      document.querySelectorAll('.remark-slide-content:not(.title-slide):not(.inverse):not(.hide-logo)')
        .forEach(function (slide) {
          const logo = document.createElement('div')
          logo.classList = 'xaringan-extra-logo'
          logo.href = null
          slide.appendChild(logo)
        })
    }
  }
  document.addEventListener('DOMContentLoaded', addLogo)
})()</script>
</div>

# NHS-R Community Introduction to GitHub webinar
----
## **An introduction before the introduction**
### Zoë Turner | 16 June 2021
</br>

---
class: inverse, middle, center

# What this talk will NOT cover...

How to set up an account

not that much about version control either

it's not going to be all that technical...

---

# What is GitHub?

### "The code is on my Github repo"

![Alt text: David from Schitt's Creek saying, "Oh God, Umm, What's th-, What's that?"](https://media.giphy.com/media/1zgOBEmZk2M8vSJxqD/giphy.gif)

---

# Who uses this (or should do)

* Analysts
* Data Scientists
* Academics
* [Teams](https://github.com/CDU-data-science-team)
* [Organisations](https://github.com/nhs-r-community)

# What does not go into it (or shouldn't do)?

* Large files
* Passwords
* Outputs (sometimes)
* Anything patient identifiable

---

## This is what a new account looks like

---

## This is what it could look like

---

# Looking for something?

---

# Searching GitHub

### By user/organisation

On an account repositories can be searched here:

.b--black.ba.bw1.br2.shadow-5.ph4.mt3[
![Image of the repository search box](img/repo-search.PNG)
]

---

# Searching GitHub

### Global search

.b--black.ba.bw1.br2.shadow-5.ph4.mt3[
![Image of the global search in GitHub](img/global-search.PNG)
]

---

### Search for NHS Number

Prompts to define by the user/organisation or in the whole of GitHub

.b--black.ba.bw1.br2.shadow-5.ph4.mt5[
![Image of search of the words NHS Number](img/search-nhsnumber.PNG)
]

---

### And this is what you get

.b--black.ba.bw1.br2.shadow-5.ph4.mt2[
![Screenshot of NHS Number search in all GitHub](img/all-github-nhsnumber.PNG)
]

---
class: inverse-white

## Like all searches...

Beware of spaces.

"NHS Number" gets 2 repositories for R but "NHSNumber" with no space gets 3 different and perhaps more useful repos

.b--black.ba.bw1.br2.shadow-5.ph4.mt2[
![Screenshot of NHSNumber search in GitHub](img/nhsnumber-r-search.PNG)
]

---

# From the beginning

---

# Start with finding a user

Looking for my own repository Lextugao007

---

# Filter repositories

.b--black.ba.bw1.br2.shadow-5.ph4.mt5[
![Image of the repository drop down](img/whats-in-github.PNG)
]
---

# Other terminology

---

# Other terminology

#### related to copying a repository

.b--black.ba.bw1.br2.shadow-5.ph4.mt2[
![Screenshot of repos that have been forked](img/forked-repos.PNG)
]

---

# Other terminology

#### related to copying a repository

.green[Clones] - doesn't appear on my GitHub and I can't make changes to the original without permission

.b--black.ba.bw1.br2.shadow-5.ph4.mt2[
![Image of error when pushing changes to a repo that's only cloned](img/cloned-but-no-permissions.PNG)
]

---

# The importance of having a README

---

class:inverse-white

# It's like a greeting to your repository

Or like the cover of a book - what is in here, why is it here, what was I thinking?

.b--black.ba.bw1.br2.shadow-5.ph4.mt2[
<a href="https://github.com/CDU-data-science-team/nottshcPublic" target="_blank"><img alt="Screenshot of a README file" src="img/readme.PNG"/></a>
]
---

# It might even be the book

A repository of READMEs

.b--black.ba.bw1.br2.shadow-5.ph4.mt2[
<a href="https://github.com/matiassingers/awesome-readme" target="_blank"><img alt="Screenshot of a readme about awesome readmes"  src="img/readme-of-readmes.PNG"/></a>
]

---

# A place for code notes

---

# Gist (or quick code)

---

# Licence to copy

---

# Is the repository open sourced?

Possible to check from the all listed repository view

.b--black.ba.bw1.br2.shadow-5.ph4.m2[
![Screenshot of a couple of repos with the licence highlighted](img/all-repos-view-licence.PNG)
]

---

# Is the repository open sourced?

And in a couple of places within individual repositories

.b--black.ba.bw1.br2.shadow-5.ph4.m2[
![Screenshot of repository with README file and link highlighted](img/individual-repo-licence.PNG)
]

---

# Individual repositories

Also look at the tags and the About, where people put links

.b--black.ba.bw1.br2.shadow-5.ph4.m2[
![Screenshot of repository with About and tags highlighted](img/about-and-tags.PNG)
]

---

# Chapters of change

---

# Branches

Main (Master is the old name) is the default code

.b--black.ba.bw1.br2.shadow-5.ph4.m2[
![Screenshot with branches and the link highlighted](img/branches.PNG)
]

---

# Branches are closely linked to issues

.b--black.ba.bw1.br2.shadow-5.ph4.m2[
![Screenshot of issues](img/issues.PNG)
]

---

# Which may be linked to branch names

Convention may to use the issue number in the branch name:

.b--black.ba.bw1.br2.shadow-5.ph4.m2[
![Screenshot of branches with issues in name](img/branches-issues-link.PNG)
]

---

# Open source 'chatting'

---

# Issues or conversations?

.b--black.ba.bw1.br2.shadow-5.ph4.mt5[
<a href="https://github.com/opensafely/risk-factors-research/issues/68" target="_blank"><img alt="Screenshot of OpenSafely issue 68 about ethnicity codes"  src="img/issue-open-conversation.PNG"/></a>
]

---

# Issues or conversations?

.b--black.ba.bw1.br2.shadow-5.ph4.mt5[
<a href="https://github.com/r-dbi/odbc/issues/86" target="_blank"><img alt="Screenshot of odbc issue 86 about SQL nvarchar(max) import errors"  src="img/odbc-issue.PNG"/></a>
]

---

# Downloading files

---

# 3 different ways to download files

---

# Free webpage publishing

---

# GitHub published webpages

If GitHub pages have been switched on it's possible to read html files...

---

class:inverse-white

# Publish a blog through GitHub

Using {distill} blogs and articles can be published (free) through GitHub

.b--black.ba.bw1.br2.shadow-5.ph4.mt5[
<a href="https://cdu-data-science-team.github.io/team-blog/" target="_blank"><img alt="Screenshot of the CDU Data Science Team's distill blog"  src="img/distill-blog-github.PNG"/></a>
]

---

![Moira from Schitt's Creek saying "Okay we can stop it there for today"](https://media.giphy.com/media/604f8OZyjjYEp5ULXY/giphy.gif)

---

# Any questions

Thanks to NHS-R Community for hosting these webinars

![Slightly moving GitHub octocat symbol with wavy edges](https://media.giphy.com/media/du3J3cXyzhj75IOgvA/giphy.gif)