Technical note Open Access

A template README for social science replication packages

Vilhuber, Lars; Connolly, Marie; Koren, Miklós; Llull, Joan; Morrow, Peter

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
README.docx
md5:4772cd95a33f83bd1a42bd4aff38d2b2
22.4 kB Download
README.html
md5:20854708981669b88ea8580e0f49368e
30.0 kB Download
README.md
md5:cbd817af3a790e8085240cc9f0970621
24.0 kB Download
README.pdf
md5:d79734361a1825726706c88d5e368722
74.5 kB Download
README.tex
md5:0e9680e2d80fdd5298b1a585c5d15ca0
35.2 kB Download
927
409
views
downloads
All versions This version
Views 927927
Downloads 409409
Data volume 18.3 MB18.3 MB
Unique views 853853
Unique downloads 300300

Share

Cite as