BITSS / WorldBankFeb2017

Materials for Feb 2017 Reproducibility Workshop at the World Bank
Other
4 stars 32 forks source link

World Bank Reproducibility Training

by Garret Christensen

UC Berkeley (Berkeley Initative for Transparency in the Social Sciences, Berkeley Institute for Data Science)

Materials for the February 2017 Reproducibility Training at the World Bank

The numbered files/directories will take you through the workshop in order.

First, 1-Intro features a set of slides (Beamer/LaTeX slides rendered as PDF) that discuss the reproducibility crisis in the social sciences.

Second, 2-GitDemo.md is an introduction to version control with Git.


Installation Instructions

The workshop will introduce you to a tool that can help you make your workflow more reproducible: version control (Git/GitHub). You are required to install the following software programs either on your personal laptop or Bank laptop before coming to the workshop for the hands-on exercises. (please remember to bring the laptop too!)

1. Version Control with Git and the Github Desktop app

Version control is a powerful way to carefully track revisions to your documents as well as to manage collaboration. Git and Github Desktop are packaged together here. Git is the command line tool, and Github Desktop is a GUI version of the same tool. There are actually a whole bunch of GUI apps that can act as front ends, so you might find later that you prefer another, but we'll stick with Github Desktop for the demo. Currently, the only Git app supported for the WBG machines is GitHub Desktop.

Optional: Specifics for Specifics Platforms

Note that Github Desktop works on Mac and Windows. If you're a Linux user, you might try one of these. Also if you're a Windows user, the command line tool that comes with Github Desktop is not the greatest, so you might want to download this alternative. If you've never used the command line before or any of this is confusing, don't worry about it and we'll try to clear it up at the workshop.

2. A good text editor

Writing good code is facilitated by a good text editor. You can get away without one because you almost certainly already have a program on your computer that can save simple ASCII text files (Notepad for Windows, or TextEdit for Mac--but change the default from Rich Text to Plain Text) but modern text editors do syntax highlighting, auto-complete, and a bunch of other cool stuff for you. I suggest Atom. You can extend its functionality by going to settings and adding packages (one to render Markdown as PDF might be especially helpful.)

Workshop Agenda

Time Session Speaker
9:30-9:45 Welcome and introductions
9:45-10:15 Overview of transparency and reproducibility in social science research Garret Christensen (BITSS)
10:15-10:45 Motivational talks - why version control? Jamie Jones (GitHub Government Team); Tariq Khokhar (World Bank Global Data Editor)
10:45-11 COFFEE BREAK
11-12:15 Version control part 1 Garret Christensen
12:15-1:15pm LUNCH BREAK
1:15-2:45 Version control part 2; including group work (hands-on session) Garret Christensen
2:45-3 COFFEE BREAK
3-3:30 How to get started with World Bank GitHub account Andrew Whitby + Kiwako Sakamoto
3:30-4:30 GitHub for TTLs - How to use GitHub as a collaboration and project monitoring tool Andrew Whitby + Kiwako Sakamoto
4:30-5 Closing discussion