prereg: R Markdown Templates for Preregistrations of Scientific Studies

CRAN/METACRAN Download counter Project Status: Active - The project has reached a stable, usable state and is being actively developed. GitHub last commit Travis build status GitHub bug issues

prereg provides R Markdown templates that facilitates authoring preregistrations of scientific studies in PDF format.

If you experience any problems or have suggestions for improvements, please open an issue.

Setup

Requirements

To use R Markdown and prereg you need the following software on your computer:

Install prereg

You can install the stable version of prereg from CRAN

install.packages("prereg")

or the development version from this GitHub repository (you may have to install the devtools package first).

install.packages("devtools")
devtools::install_github("crsh/prereg")

Create a preregistration document

Once you have installed the prereg you can select the templates when creating a new R Markdown file through the RStudio menus.

Example

prereg produces a clean form-like document.

The template file contains comments that provide further details on how to fill in the form but are invisible in the final PDF document.

Using prereg without RStudio

If you want to use prereg without RStudio you can use the rmarkdown::render function to create preregistration documents:

# Create new COS preregistration challenge R Markdown file
rmarkdown::draft(
  "my_preregistration.Rmd"
  , "cos_prereg"
  , package = "prereg"
  , create_dir = FALSE
  , edit = FALSE
)

# Render document
rmarkdown::render("my_preregistration.Rmd")

Uploading your preregistration

After knitting your preregistration to a PDF file using this package, you may upload this protocol to a trustworthy repository to complete your preregistration. Possible repositories for this are:

Acknowledgments

The templates for the preregistrations were developed by the Center for Open Science, AsPredicted.org, Anna Elisabeth van ’t Veer and Roger Giner-Sorolla, and a task force composed of members of the American Psychological Association (APA), the British Psychological Society (BPS), the German Psychological Society (DGPs), the Center for Open Science (cos), and the Leibniz Institute for Psychology (ZPID). I’m thankful for their permission to use their material in this package.

Package dependencies

References

Brandt, M. J., IJzerman, H., Dijksterhuis, A., Farach, F. J., Geller, J., Giner-Sorolla, R., … van ’t Veer, A. (2014). The Replication Recipe: What makes for a convincing replication? Journal of Experimental Social Psychology, 50, 217–224. doi: 10.1016/j.jesp.2013.10.005

van ’t Veer, A. E., & Giner-Sorolla, R. (2016). Pre-registration in social psychology—A discussion and suggested template. Journal of Experimental Social Psychology, 67, 2–12. doi: 10.1016/j.jesp.2016.03.004