-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathGitHub.Rmd
137 lines (76 loc) · 4.4 KB
/
GitHub.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
---
title: "GitHub"
author: "Kulas Renata Casey Noel"
date: "6/14/2020"
output:
xaringan::moon_reader:
seal: false
---
```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = FALSE)
```
## Learning to use GitHub through R Studio
Summer 2020 Team:
+ Renata
+ Casey
+ Noel
+ Kulas
---
## Goals
1. figure out how to integrate GitHub and R Studio
2. connect individual accounts to shared projects
3. figure out branches and forks (and how to use them)
4. learn how to ask for a task to be completed
5. learn how to approve tasks
6. share what we've learned with the larger group (if interested)
---
## How to integrate RStudio and GitHub
This [site](https://happygitwithr.com/install-git.html) walks-through the setup from within RStudio.
---
## Connecting individual accounts to shared projects (Step I)
Invite collaborators from within the GitHub repo:
...you'll need their GitHub username
---
## Connecting individual accounts to shared projects [(Step II)](https://www.youtube.com/watch?v=YxZ8J2rqhEM)
First access the GitHub repository url, then, within the R Studio interface follow the wizard via: File $\rightarrow$ *New Project* $\rightarrow$ Version Control $\rightarrow$ Git $\rightarrow$ paste the GitHub repository address into the "Repository URL:" window.
Note that you'll also indicate a local (on your computer) location for the files...
---
## Connecting individual accounts to shared projects (Success)
You now have a "project" that you can access from within R Studio, but is linked to the GitHub files (as well as somewhere locally on your computer)
---
## Then what?
You can now work on shared .Rmd files via local editing. A "commit" saves your edits, whereas a "push" sends your saved changes (aka "commits") to the online GitHub repository.
There's a decent YouTube overview [here](https://www.youtube.com/watch?v=KjLycV1IWqc)
---
## [Forking vs. branching](https://www.pluralsight.com/blog/software-development/the-definitive-guide-to-forks-and-branches-in-git#:~:text=Forking%20creates%20a%20full%20copy,what%20branch%20you%20are%20using.-)
Sounds like forks are different paths that a project may take (e.g., point of divergence) toward a different end-goal, whereas branches are shorter-term (typically) "construction zones" where edits can be temporarily held before being integrated into the master branch.
---
## Defining a new branch
Best practice seems to entail creating a branch within which proposed edits can be made and reviewed prior to "pulling" these changes to the master branch (the master is where the initial files were placed, but also where the final product will be located).
You can create a new GitHub branch from within RStudio via the `New Branch` option on the `Git` tab of RStudio's "Environment/History" panel:
---
## Additional Files
It is important to commit and push all the files that pop-up in order to publish the document through Github.
---
## Push and Pull
After making changes to a project, you need to commit those changes through the Gihub tab by selecting the documents and hitting the 'commit' button.
---
## Pulling from Github
Every time you open up a project connected to Github in which you are collaborating with others, make sure to pull anything that has been added to the repository. To do this, go to the "Git" tab on the top right and slect the "pull" button. A window will pop up letting you know its been updated.
---
## Pushing to Github
You will see a pop up window where you will add a comment to your commit and then hit commit once again. After it's done, click "push" to push those changes back to the repository on Github, and so everyone who you are collaborating with can see the changes.
---
## Things we still need to figure out!
+ how to request a change
+ how to stage