Some scientists, including economists, have put together excellent guidance and tutorials. See
All replication archives should have a README (in PDF, text, or a simple formatting language such as Markdown, like this document). The README should provide a sufficient description to understand the structure of the replication archive (directory structure, what is acquired from third parties, what is generated by scripts, how much output to expect). It should document each file or class of files that are included.
We strongly encourage the provision of a master script. The master script should run all programs necessary to provide the outputs, in the right sequence, robustly.
In some cases, the master script might also serve as a README (for instance, “README.bash”, “README.py”, “README.Rmd”), as long as it satisfies all conditions of the README as well (i.e., ample comments).
We strongly encourage setting any seeds for random number generators
Run this a first time, generating column 1 of Table 3. Then comment out line 55, then run a second time, which should give you column 3 of Table 3. Then uncomment line 55, change the parameter in line 67 to "5", and run again to get column 2 of Table 3.
(this is only slightly paraphrased from an actual example).
Have superDynare available
Use the outreg55 package
(no URL or installation command provided)
make, Matlab+Dynare, or even Stata.
ssc install outreg55, from(https://myurl/to/o) // accurate as of 2018-10-03
# Known to work with dplyr 0.7.6 install.packages(c("dplyr","devtools")) library(dplyr) library(devtools) install_github("myrepo/superols")
You should be precise about the relevant packages. Ideally specify a specific version to install, or provide the package. At a minimum, specify the version of a package that you produced your results with.
adopathto a project-specific directory.
Most economists in the late 2000s (through 2018) use either Stata or Matlab. Assume that replicators have not (yet) learned your preferred software if you are using something else, and provide some guidance how to use it.
Figure: Software usage in the AER, 2000-2018 (Source: Baylis and Schrimpf, 2018)