-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathgit-non-prog.html
699 lines (518 loc) · 20 KB
/
git-non-prog.html
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
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
<!DOCTYPE html>
<html lang="" xml:lang="">
<head>
<title>Git for Non-Programmers</title>
<meta charset="utf-8" />
<meta name="author" content="Fernando Hoces de la Guardia, BITSS" />
<meta name="date" content="2022-12-02" />
<script src="libs/header-attrs-2.11/header-attrs.js"></script>
<link href="libs/remark-css-0.0.1/default.css" rel="stylesheet" />
<link href="libs/remark-css-0.0.1/metropolis.css" rel="stylesheet" />
<link href="libs/remark-css-0.0.1/metropolis-fonts.css" rel="stylesheet" />
</head>
<body>
<textarea id="source">
class: center, middle, inverse, title-slide
# Git for Non-Programmers
## CEGA EASST Fellows Training
### Fernando Hoces de la Guardia, BITSS
### 02 December 2022
---
count:true
# Before we begin
.font150[
<br><br>
- [GitHub desktop app](https://desktop.github.com/) installed?
- Create an account at [GitHub.com](http://www.github.com/)?
- If no to any, please do it now (recommend to exit zoom temporarily to allow for internet bandwidth)
]
---
background-image: url("Images/iceberg.jpg")
background-size: 50%
background-position: 100% 50%
# Motivation: Computational Reproducibility
<!--- https://imgflip.com/i/5lb28s -->
.pull-left[
<br>
.font120[
Clarebout Principle:
</br></br>
“An article about computational science in a scientific publication is not the scholarship itself, it’s merely scholarship advertisement. The actual scholarship is the complete software development environment and the complete set of instructions which generated the figures.”
.right[ <cite> Buckheit and D.L. Donoho (1995, [2009](https://academiccommons.columbia.edu/doi/10.7916/D8QZ2MDS/download))</cite>]
]
]
---
# Git/Github for Version Control
.font150[
<br>
- Version Control Software is an increasingly popular tool for computational reproducibility
- Git is a type of VCS and Github company that build on top of .
- They are very popular among programmers, but not so much among non-programmers.
- Why? I believe it has to do with GUIs.
]
---
# What is a GUI and why the bad reputation
.font150[
<br><br>
**G**raphical **U**ser **I**nterface
- For most of us (non-programmers): *GUI = Software*.
- GUIs are behind the popularization of personal computers.
- Unfortunately GUIs are pretty bad at keeping a record of actions taken (bad for reproducibility).
]
---
# What is not a GUI?
.font140[
- Any software that is run in the command line (aka terminal, shell, bash, etc).
]
.font140[
- Git was designed to run in the command line.
- Today we will learn Git **without** the command line.
]
---
# What is Git 1/2
.font150[
<br>
- Git is a software designed to track the **entire** history of the code of a project.
- Designed originally for software development, it has gained important traction in the research community.
- Main appeal: facilitates full reproducibility and collaboration.
- Git is mainly meant to work as a non-GUI (in the command line) software.
**However:** most of the key features can be used through a GUI.
]
---
# What is Git 2/2
.font150[
<br>
- By code Git understands any type of plain text file (`myfile.R`, `myfile.do`, `.tex/.md/.txt/.csv/.etc`).
- This type of file can be understood as "human readable" as machine and human see the same fie.
- Files that are "non-human readable" are called binary files (`myfile.docx`, `myfile.xlxs`, `.pdf/.exe/.dta/.etc`).
- Git can also detect changes in binary files, but it cannot show those changes.
]
---
# What is Github
.font150[
<br>
- Github is a company that provides two services (that we care of):
- A web hosting service for all our files track with Git (public free/private $ or free if academic).
- A GUI software (Desktop App) that provides user friendly access to Git.
- Others hosting ss include: Bitbucket, GitLab, Gitkraken, etc.
- Other GUIs include: SourceTree, Gitkraken, Atom, RStudio.
]
---
# The Primary Goal of Version Control (for us)
.font150[
<br><br>
**The Goal:** keep track of any potentially meaningful modification to your code.
]
--
.font150[
**Secondary Goal:** learn how to collaborate with others using Github.
]
--
.font150[
**Bonus track:** get you excited about using open source statistical software (R, Python, Julia, etc)
]
---
# Strategy 1:
.font150[
<br>
1. Agree on a naming convention with your co-authors (eg: YYYYMMDDfilename_INITALS).
2. Begin working from the last saved version (eg: `20180325demo_FH.do`).
3. At the end of the day, save on a new version (eg: `20180327demo_FH.do`).
**Pros:** Easy adoption.
**Cons:** Error prone, hard to document, lots of files for each document.
]
---
# Strategy 2:
.font150[
<br>
1. Name your file `filename` (ideally `01_filename`)
2. Take a snapshot of your work every time you complete relevant change (day, hour or minutes).
3. Update your entire working folder to the cloud.
**Pros:** Error proof, seamless documentation, one file per document, track differences across all versions, meant to work with the cloud.
**Cons:** Harder adoption.
]
---
background-image: url("Images/phdcomics.png")
background-size: contain
# We want to avoid this situation:
---
background-image: url("Images/version_control_diagram.svg")
background-size: contain
# Comparison of Workflows
---
# Other reasons to use Git
.font150[
<br><br>
- To access a whole new world of knowledge!
- Great tool for collaboration.
- Easier to test all sorts of ideas/models.
]
---
background-image: url("Images/git.png")
background-size: contain
exclude:true
# Managing expectations
<!--
talk about undo here
-->
---
# Demos
## Five Demos:
<br>
.font140[
1 - **Simple but instructive.**
2 - Repeat with branches.
3 - Repeat with collaboration: pull requests.
4 - Repeat with collaboration: shared ownership.
5 - Explore a real life repo.
]
---
# Demo #1: We Start in the Cloud
<br>
.font130[
1 - Create [github.com](github.com) account and sign in.
2 - Let's look at some **repos:**
- Papers: [Labor](https://github.com/tyleransom/AES-Roy-Majors), [Health](https://github.com/mkiang/opioid_treatment_distance), [Public Finance](https://github.com/OpportunityInsights/welfare_analysis)
- Courses: [So](https://github.com/edrubin/EC607S21), [many](https://github.com/floswald/ScPo-Labor/), [methods](https://github.com/woerman/ResEcon703), [courses](https://github.com/paulgp/applied-methods-phd)
- Covid: [JHU](https://github.com/CSSEGISandData/COVID-19), [Imperial](https://github.com/ImperialCollegeLondon/covid19model), [NYT](https://github.com/nytimes/covid-19-data), [The Economist](https://github.com/TheEconomist/covid-19-excess-deaths-tracker), [EconTracker](https://github.com/OpportunityInsights/EconomicTracker)
- and more: [nice diagrams](https://github.com/grantmcdermott/tikzexamples), [meta-guides](https://github.com/Alalalalaki/Guide2EconRA), [books](https://github.com/BITSS/ACRE), [guaguas!](https://github.com/rivaquiroga/guaguas)
3 - First way to access content: download.
4 - What if you want to have your own copy of the repo? **Fork** it!
]
---
# Demo #1: We move to our local computer
<br>
.font130[
5 - Now create your own repo. Initiate readme and make some edits.
6 - **Clone** the repo. Explore the files and location.
7 - Create new files, edit. And **commit**. Edit again, and commit again.
8 - **Push.** Edit on github.com, and **pull.**
9 - For this tutorial, best way to access previous version: explore in github.com and download.
]
<br><br><br><br>
.right[
[here is some help with the lingo](handout.pdf)
]
---
# Five Demos 2/5:
<br>
.font140[
1 - Simple but instructive.
*Review: def repo, github.com, download, clone, destination folder, fork, create repo, commit, push, pull, delete, search repo, download old version.*
2 - **Repeat with branches.**
3 - Repeat with collaboration: pull requests.
4 - Repeat with collaboration: shared ownership.
5 - Explore a real life repo.
]
---
# .font80[Demo #2: Branches and collaboration (we wil be here a while)]
<br>
.font140[
1 - Create a branch from previous repo.
2 - Add new content (do not replace), commit a few times, and go back and forth to the main branch.
3 - Go back to main branch (master), observe file, merge.
4 - Look at the history of the main branch.
5 - Repeat 1-3 but now replace instead of adding content.
]
---
# Fatal Error!
<br><br><br><br>
<img src="Images/error_image.png" width="50%" style="display: block; margin: auto;" />
---
background-image: url("Images/calm_burn.jpg")
background-size: contain
# Burn it and start with a fresh copy!
<br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
.right[
[Jenny Bryan's Advice](https://speakerdeck.com/jennybc/happy-git-and-github-for-the-user)
]
---
# Five Demos: 3/5
<br>
.font140[
1 - Simple but instructive.
Review: def repo, github.com, download, clone, destination folder, fork, create repo, commit, push, pull, delete, search repo, download old version.
2 - Repeat with branches.
*Review: All of the above, plus: branch, merge, resolve conflicts.*
3 - **Repeat with collaboration: pull requests.**
4 - Repeat with collaboration: shared ownership.
5 - Explore a real life repo.
]
---
# Two formats of collaboration
<br>
.font140[
- One owner, many pull requests.
- Easier to control, requires constant updating of forks.
- Many owners, all can push.
- **Very** important to pull at the beginning and at before each push.
]
---
# Demo #3: Pull requests
<br>
.font140[
1 - Fork repo [github.com/BITSS/test_birthday](https://github.com/BITSS/test_birthday), and clone it into your machine.
2 - Edit fields of name, and birth date.
3 - Save, commit and push.
4 - Create your first **pull request**.
5 - Let's see if I can manage all those pull requests very quickly (maybe illustrate issues).
6 - Now find your neighbors repo of Demos 1 & 2, fork it, clone it, make a change, save, commit, and...
]
---
# Five Demos: 4/5
.font140[
1 - Simple but instructive.
Review: def repo, github.com, download, clone, destination folder, fork, create repo, commit, push, pull, delete, search repo, download old version.
2 - Repeat with branches.
Review: All of the above, plus: branch, merge, resolve conflicts.
3 - Repeat with collaboration: pull requests.
*Review: collaborate via fork + PR*
4 - **Repeat with collaboration: shared ownership. **
5 - Explore a real life repo.
]
---
# Demo #4: Many owners
.font140[
1 - Half of you (\#1): go back to the repo of demo 1 & 2 and invite a collaborator.
(Suggestion: the "forker" finds the repo, the "forkee" is invited
, edits, commits, and push/pull)
]
--
.font140[
2 - The other half (\#2): clones, commits and pushes.
]
--
.font140[
3 - \#1 commits and pushes in **different lines**.
]
--
.font140[
4 - Switch and repeat 2 & 3: \#2 commits first and pushes, then \#1.
]
--
.font140[
5 - Repeat 2 - 4 but now both of you in the same lines.
]
--
.font140[
6 - Repeat now but with branches (optional).
]
---
# Five Demos: 5/5
.font140[
1 - Simple but instructive.
Review: def repo, github.com, download, clone, destination folder, fork, create repo, commit, push, pull, delete, search repo, download old version.
2 - Repeat with branches.
Review: All of the above, plus: branch, merge, resolve conflicts.
3 - Repeat with collaboration: pull requests.
Review: collaborate via fork + PR
4 - Repeat with collaboration: shared ownership.
*Review: collaborate via share ownership.*
5 - **Explore a real life repo. **
]
---
# Demo #5: .font80[Look inside a real-life project (and collaborate!)]
.font140[
1- Find the following repo: [`github.com/BITSS/opa-wealthtax`](https://www.github.com/BITSS/opa-wealthtax).
2- Fork it and clone it.
3- Open it in your computer: `opa-wealthtax.Rproj` (needs RStudio), look around and execute
`code/dynamic_doc/wealth_tax_dd.Rmd`.
4- Find elasticities at `rawdata/edits/research.csv`, modify one elasticity, document, execute again.
5 - Find `code/interactive_visualization/server.R` and in line `1561` change `red` to `blue`
]
---
# Five Demos: 5/5
.font140[
1 - Simple but instructive.
Review: def repo, github.com, download, clone, destination folder, fork, create repo, commit, push, pull, delete, search repo, download old version.
2 - Repeat with branches.
Review: All of the above, plus: branch, merge, resolve conflicts.
3 - Repeat with collaboration: pull requests.
Review: collaborate via fork + PR
4 - Repeat with collaboration: shared ownership.
Review: collaborate via share ownership.
5 - Explore a real life repo.
*Review: All of the above, plus: how does a real-life example looks like.*
]
---
# Now go and explore!
<br>
.font140[
Some good habits:
- Commit often (<1hr)
- Always pull before you start a new session of work. Also good to pull before pushing.
- Think of your remote as the most important set of files. Get used to deleting things in your local machine.
]
---
# Want to Learn More: Version Control
## Tutorials
.font140[
- [Great 20 min intro to Git by Alice Bartlett](https://www.youtube.com/watch?v=eWxxfttcMts)
- [Great 2hr tutorial to Github by Jenny Bryan (git ninja)](https://www.rstudio.com/resources/videos/happy-git-and-gihub-for-the-user-tutorial/)
- Software Carpentry's [step-by-step tutorial (command line)](https://swcarpentry.github.io/git-novice/).
]
## Documentation
.font140[
- Jenny Bryan's [Happy Git](http://happygitwithr.com/)
- [Documentation from Matthew Gentzkow and Jesse Shapiro](http://web.stanford.edu/~gentzkow/research/CodeAndData.pdf)
- Karthik Ram's paper on [Git for Research](https://scfbm.biomedcentral.com/articles/10.1186/1751-0473-8-7)
]
---
# .font80[Economists Doing Highly Reproducible Work<sup>1</sup>]
.pull-left[
**People**
- [Nick Huntingon](https://github.com/NickCH-K)
- [Shoshana Vasserman](https://github.com/shoshievass)
- [Lars Vilhuber](https://github.com/larsvilhuber)
- [Grant McDermott](https://github.com/grantmcdermott)
- [Tyler Ransom](https://github.com/tyleransom)
- [Ed Rubin](https://github.com/edrubin)
- [Luiza Andrade](https://github.com/luizaandrade)
- [Max Kasy](https://github.com/maxkasy)
- [Matt Jensen](https://github.com/MattHJensen)
- [Jason DeBacker](https://github.com/jdebacker)
- [John Horton](https://github.com/johnjosephhorton)
- [Cora Kingdon](https://github.com/ckingdon95)
- [Chandler Lester](https://github.com/chandlerlester)
]
.pull-right[
- [Alvaro Carril](https://github.com/acarril)
- [Andrew Heiss](https://github.com/andrewheiss)
- [Lisa Rennels](https://github.com/lrennels)
- [Michael Stepner](https://github.com/michaelstepner)
- [Lachlan Deer](https://github.com/lachlandeer)
- [Rebekah Din](https://github.com/rebekahanne)
**Organizations**
- [LOST](https://lost-stats.github.io/)
- [Opportunity Lab](https://github.com/Opportunitylab)
- [Congressional Budget Office](https://github.com/US-CBO)
- [Policy Simulation Library](https://github.com/PSLmodels)
- [Gentzkow & Shapiro Lab](https://github.com/gslab-econ)
- [Urban Institute](https://github.com/UrbanInstitute)
]
</br></br>
.footnote[
[1]: Non-exhaustive list of people and organizations doing amazing reproducible work on github (other than us!)
]
</textarea>
<style data-target="print-only">@media screen {.remark-slide-container{display:block;}.remark-slide-scaler{box-shadow:none;}}</style>
<script src="https://remarkjs.com/downloads/remark-latest.min.js"></script>
<script>var slideshow = remark.create({
"ratio": "16:9",
"highlightStyle": "github",
"highlightLines": true,
"countIncrementalSlides": false
});
if (window.HTMLWidgets) slideshow.on('afterShowSlide', function (slide) {
window.dispatchEvent(new Event('resize'));
});
(function(d) {
var s = d.createElement("style"), r = d.querySelector(".remark-slide-scaler");
if (!r) return;
s.type = "text/css"; s.innerHTML = "@page {size: " + r.style.width + " " + r.style.height +"; }";
d.head.appendChild(s);
})(document);
(function(d) {
var el = d.getElementsByClassName("remark-slides-area");
if (!el) return;
var slide, slides = slideshow.getSlides(), els = el[0].children;
for (var i = 1; i < slides.length; i++) {
slide = slides[i];
if (slide.properties.continued === "true" || slide.properties.count === "false") {
els[i - 1].className += ' has-continuation';
}
}
var s = d.createElement("style");
s.type = "text/css"; s.innerHTML = "@media print { .has-continuation { display: none; } }";
d.head.appendChild(s);
})(document);
// delete the temporary CSS (for displaying all slides initially) when the user
// starts to view slides
(function() {
var deleted = false;
slideshow.on('beforeShowSlide', function(slide) {
if (deleted) return;
var sheets = document.styleSheets, node;
for (var i = 0; i < sheets.length; i++) {
node = sheets[i].ownerNode;
if (node.dataset["target"] !== "print-only") continue;
node.parentNode.removeChild(node);
}
deleted = true;
});
})();
(function() {
"use strict"
// Replace <script> tags in slides area to make them executable
var scripts = document.querySelectorAll(
'.remark-slides-area .remark-slide-container script'
);
if (!scripts.length) return;
for (var i = 0; i < scripts.length; i++) {
var s = document.createElement('script');
var code = document.createTextNode(scripts[i].textContent);
s.appendChild(code);
var scriptAttrs = scripts[i].attributes;
for (var j = 0; j < scriptAttrs.length; j++) {
s.setAttribute(scriptAttrs[j].name, scriptAttrs[j].value);
}
scripts[i].parentElement.replaceChild(s, scripts[i]);
}
})();
(function() {
var links = document.getElementsByTagName('a');
for (var i = 0; i < links.length; i++) {
if (/^(https?:)?\/\//.test(links[i].getAttribute('href'))) {
links[i].target = '_blank';
}
}
})();
// adds .remark-code-has-line-highlighted class to <pre> parent elements
// of code chunks containing highlighted lines with class .remark-code-line-highlighted
(function(d) {
const hlines = d.querySelectorAll('.remark-code-line-highlighted');
const preParents = [];
const findPreParent = function(line, p = 0) {
if (p > 1) return null; // traverse up no further than grandparent
const el = line.parentElement;
return el.tagName === "PRE" ? el : findPreParent(el, ++p);
};
for (let line of hlines) {
let pre = findPreParent(line);
if (pre && !preParents.includes(pre)) preParents.push(pre);
}
preParents.forEach(p => p.classList.add("remark-code-has-line-highlighted"));
})(document);</script>
<script>
slideshow._releaseMath = function(el) {
var i, text, code, codes = el.getElementsByTagName('code');
for (i = 0; i < codes.length;) {
code = codes[i];
if (code.parentNode.tagName !== 'PRE' && code.childElementCount === 0) {
text = code.textContent;
if (/^\\\((.|\s)+\\\)$/.test(text) || /^\\\[(.|\s)+\\\]$/.test(text) ||
/^\$\$(.|\s)+\$\$$/.test(text) ||
/^\\begin\{([^}]+)\}(.|\s)+\\end\{[^}]+\}$/.test(text)) {
code.outerHTML = code.innerHTML; // remove <code></code>
continue;
}
}
i++;
}
};
slideshow._releaseMath(document);
</script>
<!-- dynamically load mathjax for compatibility with self-contained -->
<script>
(function () {
var script = document.createElement('script');
script.type = 'text/javascript';
script.src = 'https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-MML-AM_CHTML';
if (location.protocol !== 'file:' && /^https?:/.test(script.src))
script.src = script.src.replace(/^https?:/, '');
document.getElementsByTagName('head')[0].appendChild(script);
})();
</script>
</body>
</html>