Data on GitHub The easy way to make your data available.
Update (15 June 2012): See this post for instructions on how to download GitHub based data into R if you are getting the error about an
SSL certificate problem.
GitHub is designed for collaborating on coding projects. Nonetheless, it is also a potentially great resource for researchers to make their data publicly available. Specifically you can use it to:
- store data in the cloud for future use (for free),
- track changes,
- make data publicly available for replication,
- create a website to nicely present key information about the data,
- benefit from error checking by the research community.
This is an example of a data set that I’ve put up on GitHub.
Taking advantage of these things through GitHub is pretty easy. In this post I’m going to give a brief overview of how to set up a GitHub data repository.
Note: I’ll assume that you have already set up your GitHub account. If you haven’t done this, see the instructions here (for set up in the command line) or here (for the Mac GUI program) or here (for the Windows GUI program).
Store Data in the Cloud
Data basically consists of two parts, the data and description files that explain what the data means and how we obtained it. Both of these things can be simple text files, easily hosted on GitHub:
Create a new repository on GitHub by clicking on the
New Repositorybutton on your GitHub home page. A repository is just a collection of files.
- Have GitHub create a
- Have GitHub create a
Clone your repository to your computer.
If you are using GUI GitHub, on your repository’s GitHub main page simply click the
Clone to Macor
Clone to Windowsbuttons (depending on your operating system).
If you are using command line git.
- First copy the repository’s URL. This is located on the repository’s GitHub home page near the top (it is slightly different from the page URL).
- In the command line just use the
git clone [URL]command. To clone the example data repository I use for this post type:
$ git clone https://github.com/christophergandrud/Disproportionality_Data.git
- Of course you can choose which directory on your computer to put the repository in with the
cdcommand before running
Fill the repository with your data and description file.
README.mdfile as the place to describe your data–e.g. where you got it from, what project you used it for, any notes. This file will be the first file people see when they visit your repository.
- To format the
README.mdfile use Markdown syntax.
Datafolder in the repository and save your data in it using some text format. I prefer
.csv. You can upload other types of files to GitHub, but if you save it in a text-based format others can directly suggest changes and you can more easily track changes.
Commit your changes and push them to GitHub.
In GUI GitHub click on your data repository, write a short commit summary then click
Commit & Sync.
In command line git first change your directory to the data repository with
cd. Then add your changes with
$ git add .. This adds your changed files to the ”staging area” from where you can commit them. If you want to see what files were changed type
git status -s.
- Then commit the changes with:
$ git commit -m 'a comment describing the changes'
- Then push the committed changes to GitHub with:
$ git push origin master
- For more information see this git reference page.
Create a cover site with GitHub Pages. This creates a nice face for the data repository. To create the page:
Adminbutton next to your repository’s name on its GitHub main page.
Under ”GitHub Pages” click
Automatic Page Generator. Then choose the layout you like, add a tracking ID if you like, and publish the page.
GitHub will now track every change you make to all files in the data repository each time you
commit the changes. The GitHub website and GUI program have a nice interface for seeing these changes.
Once you set up the page described in Step 5, other researchers can easily download the whole data repository either as a
.tar.gz file or
.zip. They can also go through your main page to the GitHub repository.
Specific data files can be directly downloaded into R with the
RCurl packages (and
textConnection from the
base package). To download my example data into R just type:
library(RCurl) url <- "https://raw.github.com/christophergandrud/Disproportionality_Data/master/Disproportionality.csv" disproportionality.data <- getURL(url) disproportionality.data <- read.csv(textConnection(disproportionality.data))
Note: make sure you copy the file’s raw GitHub URL.
You can use this to directly load GitHub based data into your
knitr file for direct replication.
Improve your data through community error checking
GitHub has really made open source coding projects much easier. Anybody can view a project’s entire code and suggest improvements. This is done with a
pull request. If the owner of the project’s repository likes the changes they can accept the request.
Researchers can use this same function to suggest changes to a data set. If other researchers notice an error in a data set they can suggest a change with a
pull request. The owner of the data set can then decide whether or not to accept the change.
Hosting data on GitHub and using
pull requests allows data to benefit the kind of community led error checking that has been common on wikis and open source coding projects for awhile.
Pro Git: a free book on how to use command line git.
Git Reference: another good reference for command line git.
github:help: GitHub’s reference pages.
Tweet blog comments powered by Disqus