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
Description
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.
Notes
Files
README.md
Files
(186.1 kB)
Name | Size | Download all |
---|---|---|
md5:4772cd95a33f83bd1a42bd4aff38d2b2
|
22.4 kB | Download |
md5:20854708981669b88ea8580e0f49368e
|
30.0 kB | Download |
md5:cbd817af3a790e8085240cc9f0970621
|
24.0 kB | Preview Download |
md5:d79734361a1825726706c88d5e368722
|
74.5 kB | Preview Download |
md5:0e9680e2d80fdd5298b1a585c5d15ca0
|
35.2 kB | Download |
Additional details
Related works
- Is previous version of
- Other: 10.5281/zenodo.7293838 (DOI)
- References
- https://github.com/social-science-data-editors/template_README/tree/v1.0.0 (URL)