-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.Rmd
664 lines (490 loc) · 17.9 KB
/
index.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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
---
title: "First Steps in Learning the Use of Git and GitHub in RStudio"
author: "Mouna Belaid"
institute: "Prime Analytics"
date: "October 25th, 2022"
output:
xaringan::moon_reader:
css:
- default
- css/mytheme.css
- css/mytheme-fonts.css
lib_dir: libs
seal: false
self_contained: false
nature:
highlightStyle: googlecode
highlightLines: true
countIncrementalSlides: false
ratio: 16:9
#ratio: 191:100
beforeInit: "macros.js"
slideNumberFormat: |
<div class="progress-bar-container">
<div class="progress-bar" style="width: calc(%current% / %total% * 100%);">
</div>
</div>
---
```{r meta, echo=FALSE}
library(metathis)
meta() %>%
meta_general(
description = "First Steps in Learning the Use of Git and GitHub in RStudio",
generator = "xaringan and remark.js"
) %>%
meta_name("github-repo" = "MounaBelaid/First-Steps-in-Learning-the-Use-of-Git-and-GitHub-in-RStudio") %>%
meta_social(
title = "First Steps in Learning the Use of Git and GitHub in RStudio",
url = "",
image = "",
image_alt = paste(
"Title slide of First Steps in Learning the Use of Git and GitHub in RStudio",
"Workshop delivered by Mouna Belaid"
),
og_type = "website",
og_author = "Mouna Belaid",
twitter_card_type = "summary_large_image",
twitter_creator = "@mounaa_belaid"
)
```
```{r setup, include = FALSE}
options(htmltools.dir.version = FALSE)
library(knitr)
library(xaringanExtra)
library(icons)
# set default options
opts_chunk$set(echo=TRUE,
collapse = TRUE,
fig.width = 7.252,
fig.height = 4,
dpi = 300)
# set engines
knitr::knit_engines$set("markdown")
xaringanExtra::use_tile_view()
xaringanExtra::use_panelset()
xaringanExtra::use_clipboard()
xaringanExtra::use_webcam()
xaringanExtra::use_broadcast()
xaringanExtra::use_share_again()
xaringanExtra::style_share_again(
share_buttons = c("twitter", "linkedin", "facebook")
)
```
class: title-slide, center, top
background-image: url(img/git_github.png)
background-position: 90% 75%, 75% 75%
background-size: 20%, contain
.right-column[
# `r rmarkdown::metadata$title`
### `r rmarkdown::metadata$subtitle`
**`r rmarkdown::metadata$author`**<br>
`r rmarkdown::metadata$date`
]
---
name: about-me
layout: false
class: about-me-slide, inverse, middle, center
# About me
<img style="border-radius: 50%;" src=img/Me.jpg width="150px"/>
## Mouna Belaid
### Business Intelligence Consultant<br>Prime Analytics - Paris, France<br>Organizer of R-Ladies Paris
[`r icons::fontawesome("link")`mounabelaid.netlify.app/](https://mounabelaid.netlify.app/)
[`r icons::fontawesome("twitter")`@mounaa_belaid](https://twitter.com/mounaa_belaid)
[`r icons::icon_style(icons::fontawesome("github"), scale = 1)` @MounaBelaid](https://github.com/MounaBelaid)
[`r icons::icon_style(icons::fontawesome("youtube"), scale = 1)` Mouna Belaid](https://www.youtube.com/channel/UCID33pDULsQg2y4FVlv4CnQ)
---
layout: true
<a class="footer-link" href="https://bit.ly/3f4moca">bit.ly/3f4moca; Mouna Belaid</a>
<!-- this adds the link footer to all slides, depends on footer-link class in css-->
---
# Session Outline
.pull-left[
1) Overview of Version Control, benefits of version control, and popular version control systems
2) What is Git?
3) What is GitHub?
4) Getting the most out of GitHub and Git
- Connect a new RStudio project started from scratch to GitHub
- Learn about GitHub fundamentals
- Clone an existing GitHub Repository to an RStudio Project
- Make commits
]
.pull-right[
5) Submission of a new Cheatsheet to the ["Cheatsheets" GitHub Repository](https://github.com/rstudio/cheatsheets) maintained by RStudio
]
---
# Requirements
--
template: requirements
.pull-left-narrow[
.center[<img src="img/r-rstudio.png" width="180%"/>]]
.pull-right-wide[### .black[R and RStudio installed]]
--
.pull-left-narrow[
.center[<img src="img/logo-Git.png" width="50%"/>]]
.pull-right-wide[### .black[Git installed]]
--
.pull-left-narrow[
.center[`r icons::icon_style(icons::fontawesome("github"), scale = 2)`]]
.pull-right-wide[### .black[Free GitHub account]]
---
name: question
class: inverse, middle, center
{{content}}
---
template: question
`r icons::icon_style(icons::fontawesome("question-circle"), scale = 3, fill = "white")`
# What is version control?
---
## What is version control?
.panelset[
.panel[.panel-name[Definition]
.pull-left[
Version control, also known as **source control**, is the practice of tracking and managing changes to software code.
Version control systems are software tools that help software teams manage changes to source code over time.
]
.pull-right[
.center[

<font size="-0.5"> The Turing Way project illustration by Scriberia. Used under a CC-BY 4.0
licence. DOI: <a href="https://doi.org/10.5281/zenodo.3332807">10.5281/zenodo.3332807</a> </font>
]
]
]
.panel[.panel-name[Benefits of version control]
.pull-left[
- A complete .my-red[long-term] change history of every file
- Branching and merging
- Ability to make your work more .my-red[reproducible]
]
.pull-right[
.center[

<font size="-0.5"> GitHub illustrated series by Allison Horst and Julie Lowndes.
A collaboration around open science, coding, teaching, and art.
<a href="https://www.openscapes.org/blog/2022/05/27/github-illustrated-series/">openscapes.org/blog/2022/05/27/github-illustrated-series/</a> </font>
]
]
]
.panel[.panel-name[Popular Version Control Systems]
.center[

]
]
]
---
template: question
`r icons::icon_style(icons::fontawesome("question-circle"), scale = 3, fill = "white")`
# What is Git?
---
## What is Git?
--
.pull-left-narrow[
.center[<img src="img/logo-Git.png" width="100%"/>]]
.pull-right-wide[### .black[Git is an open source software for version control, initially developed in 2005 by Linus Torvalds, the creator of the Linux operating system kernel]]
--
.pull-right-wide[### .black[Git is a distributed version control tool to track the changes in the source code of a project]]
--
.pull-right-wide[### .black[Git's key design objectives are functionality, performance, security, and flexibility]]
---
template: question
`r icons::icon_style(icons::fontawesome("question-circle"), scale = 3, fill = "white")`
# What is GitHub?
---
## What is GitHub?
--
.pull-left-narrow[
.center[<img src="img/github.png" width="50%"/>]]
.pull-right-wide[### .black[GitHub is the most popular hosting service for collaborating on code using Git. Other hosting services include Bitbucket, and Gitlab.]]
--
.pull-right-wide[### .black[GitHub is a collaboration platform.]]
--
.pull-right-wide[### .black[GitHub uses <img src="img/logo-Git.png" width="20%"/> the most popular open source version control software, to track every contribution and contributor to a defined project.]]
---
.center[

<font size="-0.2"> GitHub illustrated series by Allison Horst and Julie Lowndes.
A collaboration around open science, coding, teaching, and art.
<a href="https://www.openscapes.org/blog/2022/05/27/github-illustrated-series/">openscapes.org/blog/2022/05/27/github-illustrated-series/</a> </font>
]
---
template: question
`r emo::ji("rocket")`
# Getting Started with Git
---
## Getting Started with Git
.panelset[
.panel[.panel-name[Check that Git is installed]
**Step 1.** In the Terminal of RStudio, enter the following code
```{r, eval=FALSE, echo=TRUE}
which git
```
You can check the version of Git
```{r, eval=FALSE, echo=TRUE}
git --version
```
]
.panel[.panel-name[Communicate with GitHub via HTTPS]
.pull-left[
**Step 2.** Go to [https://github.com/settings/tokens](https://github.com/settings/tokens) and click *Generate token*

**Step 3.** Copy the generated PAT to your clipboard. Or leave that browser window open and available for a little while, so you can come back to copy the PAT.
]
.pull-right[
Provide this PAT next time a Git operation asks for your password.

Or, from RStudio, do the following:
```{r, eval=FALSE, echo=TRUE}
usethis::create_github_token()
gitcreds::gitcreds_set()
```
]
]
.panel[.panel-name[Tell Git who you are]
**Step 4.** In RStudio, click *Tools* -> *Shell* and type each line separately:
```{r, eval=FALSE, echo=TRUE}
git config --global user.email "jack.bel@gmail.com" # use your mail address instead
git config --global user.name "jack.bel" # use your GitHub username instead
```
]
]
---
template: question
`r icons::icon_style(icons::fontawesome("check-square"), scale = 3, fill = "white")`
# Getting the most out of GitHub and Git
---
## Getting the most out of GitHub and Git
.panelset[
.panel[.panel-name[1) Create a new RStudio Project and push it to GitHub]
`r emo::ji("rocket")` **Learning objectives**
- Create a new repository on GitHub
- Make commits
- Link a remote GitHub repository to a local repository
]<!---->
.panel[.panel-name[2) Clone an existing GitHub Repository to an RStudio Project]
`r emo::ji("rocket")` **Learning objectives**
- Connect a new RStudio project started from scratch to GitHub
- GitHub fundamentals
- Explore a GitHub repository
] <!---->
]
---
template: question
`r icons::icon_style(icons::fontawesome("check-square"), scale = 3, fill = "white")`
# GitHub Knowledge Base
---
## GitHub Knowledge Base
.center[

]
---
## GitHub Knowledge Base
.center[

]
---
## GitHub Knowledge Base
.center[

]
---
## GitHub Knowledge Base
.center[

]
---
## GitHub Knowledge Base
.center[

]
---
## GitHub Knowledge Base
.center[

]
---
## GitHub Knowledge Base
.center[

]
---
## GitHub Knowledge Base
.pull-left[
.my-blue[Commands] | .my-blue[Operations]
------------- | -------------
`git init <directory>` | Create empty Git repo in specified directory
`git clone <repository>` | Clone a repository located at <repository> your local machine
`git config user.name <username>` | Define author name to be used for all commits in current repository
`git add <directory>` | Stage all changes in <directory> for the next commit
]
.pull-right[
.my-blue[Commands] | .my-blue[Operations]
------------- | -------------
`git commit -m <"message">` | Commit the staged snapshot, but instead of launching a text editor, use <"message"> as the commit message
`git status` | List which files are staged, unstaged, and untracked
`git log` | Display the entire commit history using the default format
]
---
## GitHub Knowledge Base
.my-blue[Commands] | .my-blue[Operations]
------------- | -------------
`git pull <remote>` | Fetch the specified remote’s copy of current branch and immediately merge it into the local copy
`git push <remote> <branch>` | Upload local repository content to a remote repository
**Pull requests** are proposed changes to a repository submitted by a user and accepted or rejected by a repository's collaborators. Pull requests each have their own discussion forum.
**Issues** are suggested improvements, tasks or questions related to the repository. Issues can be created by anyone (for public repositories), and are moderated by repository collaborators. Each issue contains its own discussion thread.
---
template: question
`r icons::icon_style(icons::fontawesome("check-square"), scale = 3, fill = "white")`
# 1) Create a new RStudio Project and push it to GitHub
---
## 1) Create a new RStudio Project and push it to GitHub
.pull-left[
**Step 1.** In RStudio click *File* > *New Project* > *New Directory* > *New Project*


]
.pull-right[
**Step 2.** Give a name to the project in the *Directory name* tab and select *Create a git repository* then click on *Create Project*

]
---
## 1) Create a new RStudio Project and push it to GitHub
.pull-left[
**Step 3.** Create a new R script. In the next steps, this script will be added to a repository on GitHub by using Git.

]
.pull-right[
**Step 4.** The *Welcome.R* script is created and is saved in the project directory. It should also appear in the Git tab next to the *Environment* or the *History* tab. You need to select this R script on the Git panel.

]
---
name: repository
## 1) Create a new RStudio Project and push it to GitHub
.pull-left[
**Step 5.** Now click *Commit*. A new window is open. Enter an identifying
message in the *Commit message* tab.

You have now committed the current version of this *Welcome.R* script to your repository on your computer. Now you want to push the contents of this commit to GitHub, so it is also backed-up off site and available to collaborators.
]
.pull-right[
**Step 6.** Go to [GitHub](https://github.com/). Create a *New repository*, and name it
]
---
## 1) Create a new RStudio Project and push it to GitHub
**Step 7.** In the *Terminal* tab, type the following three lines of code and click enter
```{r, eval=FALSE, echo=TRUE}
git remote add origin https://github.com/MounaBelaid/Test.git # Test is the repository name that I've created on GitHub
git branch -M main
git push -u origin main
```
`r icons::icon_style(icons::fontawesome("star"), color = "#e5bf00")` You have now pushed your commit to GitHub, and should be able to see your files in your GitHub account.
The *Pull* and *Push* buttons in RStudio will now also work.

---
template: question
`r icons::icon_style(icons::fontawesome("check-square"), scale = 3, fill = "white")`
# 2) Clone an existing GitHub Repository to an RStudio Project
---
## 2) Clone an existing GitHub Repository to an RStudio Project
.pull-left[
**Step 1.** In RStudio click *File* > *New Project* > *Version Control* > *Git*

]
.pull-right[
**Step 2.** Go to the Resporitory on GitHub and click on *Code* and make a copy of the git link in order to clone this repository i.e to get a copy of this existing Git respository into your local machine.

]
---
## 2) Clone an existing GitHub Repository to an RStudio Project
**Step 3.** Go back to you R session and enter the link in *Respository URL* then click on *Create Project*

---
template: question
`r icons::icon_style(icons::fontawesome("file"), scale = 3)`
# My Submission of a new Cheatsheet to the "Cheatsheets" GitHub Repository maintained by RStudio
---
name: Cheatsheet
## My Submission of a new Cheatsheet to the "Cheatsheets" GitHub Repository maintained by RStudio: **Volunteer Basis**

---
name: Cheatsheet
## My Submission of a new Cheatsheet to the "Cheatsheets" GitHub Repository maintained by RStudio: **Volunteer Basis**

---
name: Cheatsheet
## My Submission of a new Cheatsheet to the "Cheatsheets" GitHub Repository maintained by RStudio: **Volunteer Basis**
.pull-left[
**Step 1.** *Fork* the [repository](https://github.com/rstudio/cheatsheets)

**Step 2.** Clone Git repository

]
.pull-right[


]
---
name: Cheatsheet
## My Submission of a new Cheatsheet to the "Cheatsheets" GitHub Repository maintained by RStudio: **Volunteer Basis**
.pull-left[
**Step 3.** I put the PDF document in the directory where the other PDF cheatsheets are provided

]
.pull-right[

]
---
name: Cheatsheet
## My Submission of a new Cheatsheet to the "Cheatsheets" GitHub Repository maintained by RStudio: **Volunteer Basis**
.pull-left[
**Step 4.** I did the same for the PowerPoint version

]
.pull-right[
**Step 5.** I included .png image of the first page of the *git-github* cheatsheet

]
---
name: Cheatsheet
## My Submission of a new Cheatsheet to the "Cheatsheets" GitHub Repository maintained by RStudio: **Volunteer Basis**
.pull-left[
**Step 6.** I made a *commit*



]
.pull-right[
**Step 7.** I created a *pull request*

]
---
name: Cheatsheet
## My Submission of a new Cheatsheet to the "Cheatsheets" GitHub Repository maintained by RStudio: **Volunteer Basis**
.pull-left[

]
.pull-right[
**Step 8.** I provided information about the cheatsheet in the section below

]
---
template: question
`r icons::icon_style(icons::fontawesome("file"), scale = 3)`
# Want to keep learning?
---
name: learning-resources
## Want to keep learning?
- [Happy Git and GitHub for the useR](https://happygitwithr.com/index.html): a book which was written by Jenny Bryan, the STAT 545 TAs, Jim Hester
- [GitHub Docs](https://docs.github.com/en): a full open source documentation provided by GitHub
- [Introduction to GitHub](https://lab.github.com/githubtraining/introduction-to-github): a free course offered by GitHub
---
class: goodbye-slide, inverse, middle, left
.pull-left[
<img style="border-radius: 50%;" src="img/Me.jpg" width="170px"/>
# Thank you!
### Here's where you can find me...
.right[
[mounabelaid.netlify.app/ `r icons::fontawesome("link")`](https://mounabelaid.netlify.app/)<br/>
[@mounaa_belaid `r icons::fontawesome("twitter")`](https://twitter.com/mounaa_belaid)<br/>
[@MounaBelaid `r icons::fontawesome("github")`](https://github.com/MounaBelaid)<br/>
[Mouna Belaid `r icons::fontawesome("youtube")`](https://www.youtube.com/channel/UCID33pDULsQg2y4FVlv4CnQ)<br/>
]]