Dimewiki

Difference between revisions of "Reproducible Research"

Jump to: navigation, search
Line 1: Line 1:
'''Reproducible research''' is the system of [[Data Documentation|documenting]] and [[Publishing Data|publishing]] results from any research study which allows other researchers to '''replicate''' (get the same) the results of that study using the same data for [[Data Analysis|analysis]]. The idea of reproducible research rests largely upon the idea that the path to research findings is an output equally important as the findings themselves. Researchers should make available to the public not only their results, but also their data, codes and documentation. This page provides guidelines on four key elements of reproducible research: reproducible code publication, data publication, data documentation, and output reproducibility. It is important to keep these elements in mind throughout all stages of research. </onlyinclude>
'''Reproducible research''' is the system of [[Data Documentation|documenting]] and [[Publishing Data|publishing]] results from any research study which allows other researchers to '''replicate''' (get the same) the results of that study using the same data for [[Data Analysis|analysis]]. The idea of reproducible research rests largely upon the idea that the path to research findings is an output equally important as the findings themselves. Researchers should make available to the public not only their results, but also their data, codes and documentation. This page provides guidelines on four key elements of reproducible research: '''code publication''', '''data publication''', '''data documentation''', and '''output reproducibility'''. It is important to keep these elements in mind throughout all stages of research.  


==Read First==
==Read First==

Revision as of 21:59, 16 April 2020

Reproducible research is the system of documenting and publishing results from any research study which allows other researchers to replicate (get the same) the results of that study using the same data for analysis. The idea of reproducible research rests largely upon the idea that the path to research findings is an output equally important as the findings themselves. Researchers should make available to the public not only their results, but also their data, codes and documentation. This page provides guidelines on four key elements of reproducible research: code publication, data publication, data documentation, and output reproducibility. It is important to keep these elements in mind throughout all stages of research.

Read First

  • DIME's Research Reproducibility Guidelines
  • Well-written master do-files are critical to transparent, reproducible research.
  • GitHub repositories allow researchers to track changes to code in different programming languages, create messages explaining the changes, make code publicly available and allow other researchers to read and replicate your code.
  • Data documentation outlines all aspects of the data work that may affect or inform the analysis and results.
  • Tools like LaTeX and Overleaf ensure that output is reproducible.

Overview

In most scientific fields, results are validated through replication, or when different scientists run the same experiment independently in different samples and find similar conclusions. That standard is not always feasible in development research. More often than not, the phenomena we analyze cannot be artificially re-created. Even in the case of field experiments, different populations can respond differently to a treatment – and the costs involved are high.

Even in such cases, however, we should still require reproducibility, or when different researchers run the same analysis with the same data and find the same results. That may seem obvious, but unfortunately, it is not as widely observed as we would like.

This page provides guidelines on four key elements of reproducibility in research: reproducible code publication, data publication, data documentation, and output reproducibility.

Reproducible Code Publication

Reproducible research requires that others have access to and can identically execute your code and analytical processes. With careful coding, use of master do-files and adherence to protocols, the same data and code will yield the same results for any given person. To ensure this is the case, your master do-file should set the Stata seed and version for replicable sampling and randomization; install all necessary commands and packages; specify settings; sort observations frequently; and use globals for the root folder, project folders, and units and assumptions. By nature, the master do-file will run project do-files in a pre-specified order, which strengthens reproducibility. If you use different languages or software in the same project, consider using a shell script to ensure that other users run the different languages or software in the correct order.

Code should not only be available and reproducible, but also understandable: if someone else runs your code and reproduces the results without understanding what the code did, then your research is not transparent. Comment code frequently to highlight what it is doing and why. For example, if the code drops observations or changes values, explain why through comments.

Software for Reproducible Code Publication

Git is a free version-control software. Users can store files in Git Repositories, most commonly on GitHub. Within repositories, users can track changes to code in different programming languages and create messages explaining why changes were made. Sharing Git repositories makes code publicly available and allows other researchers to read and replicate your code. To learn how to use GitHub, refer to GitHub Services’ introductory training and GitHub Guides’ tutorials. Jupyter Notebook is another platform for code-sharing on which researchers can create and share code in different programming languages, including Python, R, Julia, and Scala.

Data Publication

To execute code, reproducible research requires that researchers publish their data. Ideally, researchers can provide adequate data for others to reproduce all steps in their code from cleaning to analysis. However, this is not always feasible when the data contains personally identifiable or confidential information.

Data Documentation

For reproducibility and transparency, it is important to document all aspects of the data work that may affect or inform the analysis and results. Accordingly, during data collection, data cleaning, variable construction, and data analysis, compile data work documentation in code comments and, ideally, in one consolidated file or folder. The structure of this file or folder will vary from one project to another.

Note that when you submit codes for code review or deposit data in the microdata catalog, the reviewers will revise your data documentation. While they may provide feedback, remember that positive comments on your data documentation do not guarantee no problems, since reviewers cannot ask about issues unknown to them. For more details, see Data Documentation.

Output Reproducibility

Dynamic documents allow researchers to write papers and reports that automatically import or display results. This reduces the amount of manual work involved between analyzing data and publishing the output of this analysis, so there's less room for error and manipulation.

Different software allows for different degrees of automatization. R Markdown, for example, allows users to write, text, and code simultaneously, running analyses in different programming languages and printing results in the final document along with the text. Stata 15 allows users to dyndoc to create similar documents; the output is a file, usually a PDF, that contains text, tables and graphs. With this kind of document, whenever a researcher updates data or changes the analysis, he/she only needs to run one file to generate a new final paper or report. No copy-pasting or manual changes are necessary, which improves reproducibility.

LaTeX is another widely used tool in the scientific community. It is a type-setting system that allows users to reference code outputs such as tables and graphs in order to easily update them in a text document. After you analyze the data in your preferred software, you can export the results into TeX format – R's stargazer is commonly used for this, and Stata has different options such as esttab and outreg2. The TeX code writes a LaTex document that uploads these outputs. Whenever results are updated, simply recompile the LaTeX document with the press of a button in order to integrate the new graphs and tables. Should you wish to use TeX collaboratively, Overleaf is a web-based platform that facilitates TeX collaboration, and Jupyter Notebook can create dynamic documents in HTML, LaTeX and other formats.

Additional Resources

Retrieved from "https://dimewiki.worldbank.org/index.php?title=Reproducible_Research&oldid=6239"