prereg v0.4.0

0

Monthly downloads

0th

Percentile

R Markdown Templates to Preregister Scientific Studies

Provides a collection of templates to author preregistration documents for scientific studies in PDF format.

Readme

prereg: R Markdown Templates for Preregistrations of Scientific Studies

CRAN status Download counter Project Status: Active - The project has reached a stable, usable state and is being actively developed. Build status

prereg provides R Markdown templates that facilitates authoring preregistrations of scientific studies in PDF format. The templates are based on the Center for Open Science Preregistration Challenge, the AsPredicted.org questions, a template suggested for social psychology by van 't Veer and Giner-Sorolla (2016), and the replication recipe suggested by Brandt et al. (2013).

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")

Acknowledgements

The templates for the preregistrations were developed by the Center for Open Science, AsPredicted.org, and Anna Elisabeth van 't Veer and Roger Giner-Sorolla, respectively. 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

Functions in prereg

Name Description
brandt_prereg Brandt et al. Replication Recipe Preregistration template
aspredicted_prereg AsPredicted.org template
vantveer_prereg van 't Veer & Giner-Sorolla Preregistration template
cos_prereg COS Preregistration Challenge template
prereg R Markdown Templates to Preregister Scientific Studies
No Results!

Last month downloads

Details

Type Package
Date 2019-1-9
URL https://github.com/crsh/prereg
BugReports https://github.com/crsh/prereg/issues
License GPL-3
LazyData TRUE
RoxygenNote 6.0.1
NeedsCompilation no
Packaged 2019-01-09 16:35:45 UTC; frederikaust
Repository CRAN
Date/Publication 2019-01-09 17:00:06 UTC
depends R (>= 3.0.0)
imports rmarkdown (>= 1.0)
suggests testthat
Contributors

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/prereg)](http://www.rdocumentation.org/packages/prereg)