SpatialDataScience/11_Git.html at gh-pages · learner-python-R/SpatialDataScience

History

642 lines (583 loc) · 21.8 KB

Raw

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

<!DOCTYPE html>

<head>

<title>Version Control (with Git)</title>

href="site_libs/highlight/textmate.css"

type="text/css" />

pre:not([class]) {

background-color: white;

}

</style>

if (window.hljs && document.readyState && document.readyState === "complete") {

window.setTimeout(function() {

hljs.initHighlighting();

}, 0);

}

</script>

h1 {

font-size: 34px;

}

h1.title {

font-size: 38px;

}

h2 {

font-size: 30px;

}

h3 {

font-size: 24px;

}

h4 {

font-size: 18px;

}

h5 {

font-size: 16px;

}

h6 {

font-size: 12px;

}

.table th:not([align]) {

text-align: left;

}

</style>

</head>

<body>

.main-container {

max-width: 940px;

margin-left: auto;

margin-right: auto;

}

code {

color: inherit;

background-color: rgba(0, 0, 0, 0.04);

}

img {

max-width:100%;

height: auto;

}

.tabbed-pane {

padding-top: 12px;

}

button.code-folding-btn:focus {

outline: none;

}

</style>

/* padding for bootstrap navbar */

body {

padding-top: 51px;

padding-bottom: 40px;

}

/* offset scroll position for anchor links (for fixed navbar) */

.section h1 {

padding-top: 56px;

margin-top: -56px;

}

.section h2 {

padding-top: 56px;

margin-top: -56px;

}

.section h3 {

padding-top: 56px;

margin-top: -56px;

}

.section h4 {

padding-top: 56px;

margin-top: -56px;

}

.section h5 {

padding-top: 56px;

margin-top: -56px;

}

.section h6 {

padding-top: 56px;

margin-top: -56px;

}

</style>

// manage active state of menu based on current page

$(document).ready(function () {

// active menu anchor

href = window.location.pathname

href = href.substr(href.lastIndexOf('/') + 1)

if (href === "")

href = "index.html";

var menuAnchor = $('a[href="' + href + '"]');

// mark it active

menuAnchor.parent().addClass('active');

// if it's got a parent navbar menu mark it active as well

menuAnchor.closest('li.dropdown').addClass('active');

});

</script>

$(document).ready(function () {

window.buildTabsets("TOC");

});

</script>

</button>

<a class="navbar-brand" href="index.html">GEO 503: R Spatial Data Science</a>

</div>

<li>

</li>

<li>

<a href="Syllabus.html">Syllabus</a>

</li>

<li>

<a href="Schedule.html">Schedule</a>

</li>

Content

</a>

<li>

<a href="CourseContent.html">About Course Content</a>

</li>

<li class="dropdown-header">Module 1: Introduction to R</li>

<li>

<a href="00_CourseIntroductionFrame.html">00 Course Introduction</a>

</li>

<li>

<a href="01_Rintro.html">01 First Steps</a>

</li>

<li>

<a href="02_DataWrangling.html">02 Data Wrangling</a>

</li>

<li>

<a href="03_Plotting.html">03 Plotting</a>

</li>

<li class="dropdown-header">Module 2: Spatial Analyses</li>

<li>

<a href="04_Spatial.html">04 Spatial Data</a>

</li>

<li>

<a href="05_Raster.html">05 Spatial Raster Data</a>

</li>

<li>

<a href="06_RasterTwo.html">06 More Raster Data</a>

</li>

<li class="dropdown-header">Module 2: Advanced Programming</li>

<li>

<a href="07_Reproducibile.html">07 Reproducible Research</a>

</li>

<li>

<a href="08_WeatherData.html">08 Weather Data Processing</a>

</li>

<li>

<a href="09_RemoteSensing.html">09 Satellite Data Processing</a>

</li>

<li>

<a href="10_ParallelProcessing.html">10 Parallel Processing</a>

</li>

<li>

<a href="11_Git.html">11 Version Control with Git</a>

</li>

</ul>

</li>

Assignments

</a>

<li>

<a href="Homework.html">Homeworks</a>

</li>

<li>

<a href="PackageIntro.html">Package Introduction</a>

</li>

<li>

<a href="Project.html">Final Project</a>

</li>

</ul>

</li>

Resources

</a>

<li>

<a href="Resources.html">Resources</a>

</li>

<li>

<a href="GitSSHNotes.html">Setting up Github</a>

</li>

</ul>

</li>

</ul>

<li>

</a>

</li>

</ul>

</div>

</div>

</div>

<h1 class="title toc-ignore">Version Control (with Git)</h1>

</div>

<h1>Background</h1>

<p>“The goal of reproducible research is to tie specific instructions to data analysis and experimental data so that scholarship can be recreated, better understood and verified.” <small> Max Kuhn, CRAN Task View: Reproducible Research </small></p>

</blockquote>

<h2>Our work exists on a spectrum of reproducibility</h2>

<p><small>Peng 2011, Science 334(6060) pp. 1226-1227</small></p>

<p>In this module you will explore the use of software called Git to manage ‘versions’ of files. Similar to ‘track-changes’ in Microsoft Word, Git keeps track of any edits and makes it possible to track who made the change and when. Git (and other version control software) are most commonly used to manage collaboratively edited code, but it can keep track of any file.</p>

</div>

<h2>Benefits are straightforward</h2>

<ul>

<li><strong>Verification & Reliability</strong>: Find and fix bugs. Today’s results == tomorrow’s.</li>

<li><strong>Transparency</strong>: increased citation count, broader impact, improved institutional memory</li>

<li><strong>Efficiency</strong>: Reduces duplication of effort. Payoff in the (not so) long run</li>

<li><strong>Flexibility</strong>: When you don’t ‘point-and-click’ you gain many new analytic options.</li>

</ul>

</div>

<h2>Common practices of many scientists</h2>

<ul>

<li>Enter data in Excel</li>

<li>Use Excel for data cleaning & descriptive statistics</li>

<li>Import data into SPSS/SAS/Stata for further analysis</li>

<li>Use point-and-click options to run statistical analyses</li>

<li>Copy & paste output to Word document, repeatedly</li>

</ul>

<p>These steps can be very difficult to reproduce (even for the same person at a later date)!</p>

</div>

<h1>Version Control</h1>

<h2>Tracking changes with version control</h2>

<p><strong>Payoffs</strong></p>

<ul>

<li>Eases collaboration</li>

<li>Can track changes in any file type (ideally plain text)</li>

<li>Can revert file to any point in its tracked history</li>

</ul>

<p><strong>Costs</strong></p>

<ul>

<li>Learning curve</li>

</ul>

</div>

<ul>

<li><strong>Strong support for non-linear development:</strong> Rapid branching and merging, specific tools for visualizing and navigating a non-linear development history.</li>

<li><strong>Distributed development:</strong> No central server needed, each user has a full copy</li>

<li><strong>Efficient handling of large projects:</strong> Designed to manage the Linux OS</li>

<li><strong>Cryptographic authentication of history:</strong> The ID of a particular version depends uponthe complete history. Once published, it is not possible to change the old versions without it being noticed.</li>

</ul>

</div>

<h2>Git Has Integrity</h2>

<p>Everything <em>checksummed</em> before storage and then referred by <em>checksum</em>.</p>

<p>It’s impossible to change the contents of any file or directory without Git knowing. You can’t lose information in transit or get file corruption without Git being able to detect it.</p>

</blockquote>

</div>

<h2>Checksum</h2>

<p>A way of reducing digital information to a unique ID:</p>

<p>A 40-character hexadecimal SHA-1 hash: <code>24b9da6552252987aa493b52f8696cd6d3b00373</code></p>

<p>Git doesn’t care about filenames, extensions, etc. It’s the information that matters…</p>

</div>

<h1>Git Tutorial: let’s get started</h1>

<p>Take 15 minutes or so at <a href="https://try.github.io/levels/1/challenges/1">this site to walk through some basic git commands</a><br> <a href=https://try.github.io/levels/1/challenges/1> <img src="11_assets/trygit.png" alt="alt text" width="75%"></a></p>

</div>

<h2>The 3 states of files</h2>

<h3>staged, modified, committed</h3>

<p>The important stuff is hidden in the <code>.git</code> folder.</p>

</div>

<h2>Github</h2>

<p>GitHub is a web-based Git repository hosting service. It offers all of the distributed version control and source code management (SCM) functionality of Git as well as adding its own features. It provides access control and several collaboration features such as bug tracking, feature requests, task management, and wikis for every project. <small> <a href=https://en.wikipedia.org/wiki/GitHub> Wikipedia </a> </small></p>

</blockquote>

<p>There are other ways to use Git, you can host your own server or use another private company, such as BitBucket.</p>

<p>You can think of GitHub as part:</p>

<ul>

<li>Server to back up your files</li>

<li>Website to share your files</li>

<li>Method to track changes to your files</li>

<li>Platform to collaboratively develop code (or other files)</li>

</ul>

<h3>Example: this course website is managed using Git & GitHub</h3>

</div>

<h2>Install Git on your computer</h2>

<h3>Windows and OSX</h3>

<p><a href="http://git-scm.com/downloads" class="uri">http://git-scm.com/downloads</a></p>

</div>

<h3>Linux</h3>

<p><code>sudo apt-get install git</code> or similar</p>

</div>

<h2>Creating an account on <a href="github.com">GitHub</a></h2>

<li>Create a GitHub account at <a href="https://github.com/" class="uri">https://github.com/</a>

<ul>

<li>This will be a public account associated with your name</li>

<li>Choose a username wisely for future use</li>

<li>Don’t worry about details, you can fill them in later</li>

</ul></li>

<li>Create a repository called <em>demo</em>

<ul>

<li>Add a brief and informative description</li>

<li>Choose “Public”</li>

<li>Check the box for “Initialize this repository with a README”</li>

</ul></li>

<li>Click “Create Repository”</li>

</ol>

</div>

<h2>In RStudio: <code>clone</code> the repository</h2>

<li>Go to RStudio

<ul>

<li>File -> New Project</li>

<li>Version Control: Checkout a project from a version control repository</li>

<li>Git: Clone a project from a repository</li>

</ul></li>

<li>Fill in the info:

<ul>

<li>URL: use HTTPS address</li>

<li>Create as a subdirectory of: Browse and create a new folder called <code>GEO503</code> (or similar)</li>

</ul></li>

</ol>

<p>To set up a connection that doesn’t require you to type in your password every time, <a href="GitSSHNotes.html">see here</a></p>

</div>

<h2>Commit to GitHub from within RStudio</h2>

<h3>Steps:</h3>

<li>Edit: make changes to a file in the repository you cloned above</li>

<li>Stage: tell git which changes you want to commit</li>

<li>Commit (with a message)</li>

<li>Push: send the updated files to GitHub</li>

</ol>

</div>

<h2>Staging</h2>

<p>Select which changed files (added, deleted, or edited) you want to commit.</p>

</div>

<h2>Committing</h2>

<p>Add a <em>commit message</em> and click commit.</p>

</div>

<h2>Syncing (<code>push</code>)</h2>

<p>Click the green arrow to sync with GitHub.</p>

</div>

<h2>Git File Lifecycle</h2>

</div>

<h2>Git command line from RStudio</h2>

<p>RStudio has limited functionality.</p>

</div>

$ git <verb> --help

$ man git-<verb></code></pre>

<p>For example, you can get the manpage help for the config command by running <code>git help config</code></p>

</div>

<h2>Git status</h2>

<p>Similar to info in git tab in RStudio</p>

</div>

<h2>Git config</h2>

<p><code>git config</code> shows you all the git configuration settings:</p>

<ul>

<li><code>user.email</code></li>

<li><code>remote.origin.url</code> (e.g. to connect to GitHub)</li>

</ul>

</div>

<h2>Branching</h2>

<p>Branches used to develop features isolated from each other. <img src="11_assets/Merge.png" alt="alt text" width="100%"></p>

<p>Default: <em>master</em> branch. Use other branches for development/collaboration and merge them back upon completion.</p>

</div>

<h2>Basic Branching</h2>

<pre><code>$ git checkout -b devel # create new branch and switch to it

$ git checkout master #switch back to master

$ git merge devel #merge in changes from devel branch</code></pre>

<p>But we won’t do much with branching in this course…</p>

</div>

<p>Check out the (free) book <a href="https://git-scm.com/book/en/v2">ProGIT</a></p>

<p>Or the <a href="https://training.github.com/kit/downloads/github-git-cheat-sheet.pdf">cheatsheet</a>.</p>

</div>

<h2>Philosphy</h2>

<p>Remember, the data and code are <em>real</em>, the products (tables, figures) are ephemeral…</p>

</div>

<h2>Git and RMarkdown</h2>

<h3>Visualize .md on GitHub</h3>

<p>Update the YAML header to keep the markdown file</p>

<pre class="r"><code>title: "Untitled"

author: "Adam M. Wilson"

output: html_document</code></pre>

<pre class="r"><code>title: "Demo"

author: "Adam M. Wilson"

output:

html_document:

keep_md: true</code></pre>

<p>And click <code>knit HTML</code> to generate the output</p>

</div>

<h2>Visualize example</h2>

<h3>Explore markdown<->Git</h3>

<li>Use <em>File -> New File -> R Markdown</em> to create a new markdown file.<br />

</li>

<li>Use the Cheatsheet to add sections (<code>#</code> and <code>##</code>) and some example narrative.<br />

</li>

<li><code>Stage</code>, <code>Commit</code>, <code>Push</code>!</li>

<li>Make more changes then <code>Stage</code>, <code>Commit</code>, <code>Push</code>!</li>

<li>Explore the markdown file on your GitHub website.</li>

</ol>

</div>

<h2>Motivations: Claerbout’s principle</h2>

<p>“An article about computational result is advertising, not scholarship. The actual scholarship is the full software environment, code and data, that produced the result.” <small> Claerbout and Karrenbach, Proceedings of the 62nd Annual International Meeting of the Society of Exploration Geophysics. 1992</small></p>

</blockquote>

</div>

<h2>Colophon</h2>

<ul>

<li><a href="https://github.com/benmarwick/CSSS-Primer-Reproducible-Research">Slides based on Ben Marwick’s presentation to the UW Center for Statistics and Social Sciences (12 March 2014)</a> (<a href="http://orcid.org/0000-0001-7879-4531">OrcID</a>)</li>

<li>Git Slides based on materials from Dr. Çetinkaya-Rundel</li>

</ul>

</div>

(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){

(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),

m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)

})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-2684666-2', 'auto');

ga('send', 'pageview');

</script>

/* * * CONFIGURATION VARIABLES: EDIT BEFORE PASTING INTO YOUR WEBPAGE * * */

var disqus_shortname = 'rdataanalysis'; // required: replace example with your forum shortname

var disqus_identifier = "{{ page.url }}";

/* * * DON'T EDIT BELOW THIS LINE * * */

(function() {

var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;

dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';

(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq );

})();

</script>

comments powered by Disqus.</a>

</noscript>

<br/>

</div>

<a rel="license" property="http://creativecommons.org/ns#license"

href="http://creativecommons.org/licenses/by/4.0/" ><img src="img/cc-by.svg" alt="cc-by"/></a>

</div>

</footer>

</div>

// add bootstrap table styles to pandoc tables

$(document).ready(function () {

$('tr.header').parent('thead').parent('table').addClass('table table-condensed');

});

</script>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

11_Git.html

Latest commit

History

11_Git.html

File metadata and controls