A template README for social science replication packages

Vilhuber, L., Connolly, M., Koren, M., Llull, J., & Morrow, P. (2020). A template README for social science replication packages (v1.0.0). Zenodo. https://doi.org/10.5281/zenodo.4319999

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.

El README típico de las revistas de ciencias sociales tiene como objetivo guiar al lector a través del material disponible y mostrarle cómo replicar los resultados del artículo de investigación, incluyendo la descripción del origen de los datos y/o la descripción de los programas. Por lo tanto, un buen archivo README debe proporcionar primero una breve descripción general del material disponible y una breve guía sobre cómo proceder de principio a fin, antes de entrar en detalles. Estas plantillas estructuran dicho README de manera que se ajuste al flujo de trabajo típico de datos y códigos en las ciencias sociales.

Referencia incluída en la guía de Datos de investigación BUVA: Descripción de los Datasets -Universidad de Valladolid Biblioteca