Published November 5, 2022
| Version v1.1
Technical note
Open
A template README for social science replication packages
Authors/Creators
- 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
social-science-data-editors/template_README-v1.1.zip
Files
(134.7 kB)
| Name | Size | Download all |
|---|---|---|
|
md5:f562be1bc6c99fbe47e93a1888924326
|
134.7 kB | Preview Download |
Additional details
Related works
- Is new version of
- Technical note: 10.5281/zenodo.4319999 (DOI)
- Is supplement to
- https://github.com/social-science-data-editors/template_README/tree/v1.1 (URL)