Git and GitHub

MATH/COSC 3570 Introduction to Data Science

Dr. Cheng-Han Yu
Department of Mathematical and Statistical Sciences
Marquette University

Version Control and Collaboration
Git and GitHub

file:///Users/chenghanyu/Dropbox/academia/books/r/teach-r-online-master/03-git/03-git.html#14

Git and GitHub

• Git is a version control system – like Track Changes features from MS Word, on steroids.
• It’s not the only version control system, but it’s a popular one.

• GitHub is a home for Git-based projects (repository, or repo) on the cloud – like Dropbox but much better.
• We’ll use GitHub for web hosting homework.

Versioning

Source: Data Science in a Box Unit 1 - Deck 3

• So think about this figure here. Versioning is like this. If you are playing Lego, and you want to build a house using Lego bricks, you would lay them out layer by layer, and you might along the way actually record what’s happening at each step.
• Base floor, walls, pillars, roof.

When we want to take a snapshot of our current work, we create a commit.

The idea is with Git, When we want to take a snapshot of our current work, we create something called commit, which is a message telling us what the version being committed is about.

Versioning with human readable messages

• Informative messages: let the next person know what happened with each change.

Source: Data Science in a Box Unit 1 - Deck 3

• Version control with git feels a lit more like this, where you have the versions, but then you actually have some human readable messages.
• Remember usually there are several people working on the same project, Adding a message on a particular version of your work let other people know what changes you made in this version comparing to the previous version.
• Even the project is an individual project, adding messages remind ourselves of what we did previously at each stage of the work.
• In Git, The first commit which is a human readable message you make in a repository is always called the first commit or initial commit.
• Then after that you get to choose what you wanna say about it.
• Like here in version 2, we have built back and front of the base, and then in version 3, finished building base, so we are actually letting the next person who come after you that could be you looking back at a project of yours or somebody else you are collaborating with know what happened with each change
• Installation instruction.
• furniture assembly guide

Why Need Version Control

• Think if you are not using version control, you very much can end up in a situation like this where you have a document you are working on, and you know we are humans feel like ok i’m almost done, I’m going to call this particular version I have final.doc.
• But then you actually get some maybe revision comments from your advisor, and then that becomes final_rev2.doc. And you go back and forth lots of times. At the end, it’s everything like final, final3, final10, final_last whatever, it just keeps going.
• The thing is these file names are not really very informative because final or final revisions don’t really say anything.
• But if you really had tagged the changes you make between the final and the final 2, that could actually be informative if you actually have to go back to them.

When you commit a file or set of files,
Git will save some information automatically.

How We Use Git and GitHub

• On GitHub, I create organization math3570-s24 and repos.

Source: Data Science in a Box Unit 1 - Deck 3

• How are we going to use Git/GitHub in this class?
• We have a course organization (2024-spring-math-3570) I created on GitHub.
• Within the organization, there will be a bunch of repositories I created for you.
• Think each repo as a project you will be working on. It is basically your homework assignment.

How We Use Git and GitHub

• You clone the repo I create for you to your Posit Cloud as an project.

Source: Data Science in a Box Unit 1 - Deck 3

• And what you will do is you are going to go to your GitHub, find the repo that’s named after you, and then clone this as an rstudio project.
• We talked about creating projects in our rstudio, but just lauching them there within Rstudio.
• This time we are going to create a project from GitHub, and that’s called cloning

How We Use Git and GitHub

• You push your updated work in Posit Cloud back to GitHub.

Source: Data Science in a Box Unit 1 - Deck 3

• So you are going to clone them in Posit Cloud, and then you are going to do your assignment, write R code, and finally version control your files with Git.
• So along the way, as you make some changes, you are going to tag these changes as commits, then every once a while, you are going to push your changes back to the repo, which means that by the deadline of an assignment, your changes need to appear in your repo, because what I will be looking at for you is not what’s happening in Posit Cloud, but actually what’s happening on GitHub. The process of of uploading your new version of work into GitHub is called Push
• You push your updated work in Rstudio back to GitHub, so that as your collaborator, I can see your updated work.

Git Ready for Data Science

• Go to https://github.com/ to create a GitHub account if you don’t have one.
  • Use the same username and email address of your Posit Cloud.
• Account (topright) > Settings
  • Emails > Uncheck “Keep my email address private” (Link your R/Python work to GitHub)
  • Public Profile > Cool name and nice picture!
• Share your GitHub username at https://forms.office.com/r/k0L5M5TyS7, so I can invite you to join our course organization math3570-s24.

• Verify your GitHub email Adjust your GitHub settings for a more pleasant GitHub experience.
• We’ll work with R, RStudio, Git, and GitHub together, like a real data scientist!

Git Ready for Data Science

• Please accept my invitation to join the GitHub organization math3570-s24.

• use ghclass_code.R and add usernames in students vector.
• Check Who is already in and make sure there are 29 of them.

Git and GitHub Tips

• Posit Cloud has installed Git for us! 😄
• There are millions of git commands, and very few people know them all.
• 99% of the time you will use Git to add, commit, push, and pull.

ok, that’s an exaggeration, but there are a lot of them

• If you google for help and this is the solution…
• Skip that and move on to the next resource!

• We will be doing Git things and interfacing with GitHub through RStudio.
• If you google for help you might come across methods for doing these things in the command line.
• Skip that and move on to the next resource unless you feel comfortable trying it out.

Connecting Posit Cloud and GitHub Together

• OK now you all have a GitHub account and Posit Cloud. We are gonna connect these two together, so that we can bring a repo in GitHub into Posit Cloud, and submit your work in Posit Cloud to your GitHub. Alright.

Connect Posit Cloud and GitHub: Step 1

• Posit Cloud cannot recognize your GitHub account unless you connect them each other.

• In Posit Cloud, click on your name on the top-right corner to open the right menu.

• Click on Authentication.

Connect Posit Cloud and GitHub: Step 2

• In the Authentication window, check the box for Enabled.

• When check Enabled, will jump to GitHub page shown in the next.

Connect Posit Cloud and GitHub: Step 3

• For your GitHub page, click on the green box that says “Authorize rstudio”.

Connect Posit Cloud and GitHub: Step 4

• Back to the Authentication of Posit Cloud, check Private repo access also enabled.

• Make sure math3570-s24 shows up under Organization access.

• Click on Request

• Click on the green box “Authorize rstudio”.

• When check Private repo access also enabled, will jump to GitHub page as shown.

Connect Posit Cloud and GitHub: Step 5

• Once you’re done, both of these boxes should be checked.

Connect Posit Cloud and GitHub: Step 5-1

Connect Posit Cloud and GitHub: Step 6

• Confirm that you’ve linked up your GitHub and Posit Cloud accounts GitHub settings > Applications. Should see Posit Cloud listed as an authorized app under Authorized OAuth Apps.

• If you see RStudio is under the Authorized Apps, congratulations! Your RStudio and GitHub are now linked together!

GitHub to Posit Cloud

GitHub to Posit Cloud: Step 1

• Each of your assignments will begin with the following steps.
• Go to the repo named hw00-yourusername I created for you.

https://mine-cetinkaya-rundel.github.io/teach-r-online/ - OK. Now let’s see how to clone a repo in GitHub to your RStudio.

• Use the code

• This repo contains a template you can build on to complete your assignment.

GitHub to Posit Cloud: Step 2

• On GitHub,
  • Click on the green Code button, select HTTPS.
  • Click on the clipboard icon on the right to copy the repo URL, such as https://github.com/math3570-s24/hw00-chenghanyu.git

GitHub to Posit Cloud: Step 3

• Go to Posit Cloud and into the course workspace 2024-spring-math-3570.
• New Project > New Project from Git Repo.

You will need to click on the down arrow next to the New Project button to see this option.

GitHub to Posit Cloud: Step 4

• Copy and paste the URL of your assignment repo into the dialog box.
• Hit OK, and you’re good to go!

GitHub to Posit Cloud: Step 5

• Click hw00-yourusername to do your assignment in Posit Cloud!

• Done! We learned the entire process of cloning a repo on GitHub to Posit Cloud as a project.

• Next, we’ll see how to keep your revision record (commit) and send (push) the latest revised version of your work from Posit Cloud to GitHub!

Posit Cloud to GitHub

Personal Access Token (PAT): Step 1

• GitHub has removed the support for Password Authentication for Git operations.

• Before we can send our work in Posit Cloud to GitHub, we need Personal Access Token (PAT)

• Settings > Developer settings

• GitHub has removed the support for Password Authentication for Git operations.
• for more safety.
• from 08/13/2021.

Personal Access Token (PAT): Step 2

Personal Access Token (PAT): Step 3

Personal Access Token (PAT): Step 4

Personal Access Token (PAT): Step 5

• Copy and paste your PAT to a secrete and safe space!!

Posit Cloud to GitHub: Step 1 - Edit your file

• Open a Quarto (qmd) file in your project, in YAML change the author name to your name.

• Click Render to generate your beautiful document. (If you are asked to install any packages, please do!)

Posit Cloud to GitHub: Step 2 - Commit changes

• Go to the Git tab in your RStudio.
• Click on Diff. This shows you the difference between the last committed state of the document and its current state that includes your changes.
• Check Staged box to add files to be committed.
• Write “Update author’s name” in the Commit message box and hit Commit.

Posit Cloud to GitHub: Step 3 - Push changes

• We’ve made an update and committed this change locally.
• It’s time to push the changes to your repo on GitHub, so that others (Dr. Yu) can see your changes.
• Click on Push.
• In the prompted dialogue box, enter your GitHub user name, and your password (PAT).

https://inbo.github.io/git-course/course_rstudio.html

Posit Cloud to GitHub: Step 3 - Updated Repo

• Back to your GitHub repo and refresh it.

• The online repo is now synced with your local project in Posit Cloud.

Resources

• Create a personal access token (PAT)
• Two-factor authentication
• Git hands-on session within RStudio
• Happy Git and GitHub for the useR
• Happier version control with Git and GitHub

Exercise: Click on the more button in the git pane and select Shell Type git config –global credential.helper store Type exit to quit the shell