Published December 8, 2020 | Version v1.0.0
Technical note Open

A template README for social science replication packages

  • 1. Cornell University
  • 2. Université du Québec à Montréal
  • 3. Central European University
  • 4. Barcelona Graduate School of Economics
  • 5. University of Toronto


The typical README in social science journals serves the purpose of guiding a reader through the available material and a route to replicating the results in the research paper, including the description of the origins of data and/or description of programs. As such, a good README file should first provide a brief overview of the available material and a brief guide as to how to proceed from beginning to end, before then diving into the specifics. These template files structure such a README in a way that is compliant with the typical data and code workflow in the social sciences.


The README is under a CC-BY-NC license. Usage by commercial entities is allowed, reselling it is not.


Files (186.1 kB)

Name Size Download all
22.4 kB Download
30.0 kB Download
24.0 kB Preview Download
74.5 kB Preview Download
35.2 kB Download

Additional details