preregRS

This package provides a RMarkdown template for preregistrations with research syntheses (preregRS).
Authors are:

• Jürgen Schneider
• Iris Backfisch

Try it out with this jupyter notebook:

Click on the button and open the 'preregRS.Rmd'.

Installation

install.packages("remotes")
remotes::install_github("j-5chneider/preregRS")
# Please report any installation bugs in the issues

Currently
you will also need to install the development version of the kableExtra package. Otherwise you will get an error when compiling to HTML or PDF. This bug is already fixed, but not yet in the CRAN version of the package.

install.packages("devtools")
devtools::install_github("kupietz/kableExtra")

When compiling to PDF
You will need to install TinyTex (but, you know, HTML is better anyways):

install.packages('tinytex')
tinytex::install_tinytex()

Usage

Open Template

1. Install the package (see above)
2. Go to File > New File > R Markdown...
3. Choose From Template and choose either preregRS to HTML or preregRS to PDF

Fill out Template

• We recommend to compile the .Rmd file first to get a glimpse at how the final preregistration will be structured (sections). Do this by hitting the "knit" button in RStudio.
• To get a better idea of what you can specify in each section, we included the original descriptions from the sources used (PRISMA-P, PROSPERO, MARS). Get this information by clicking the "more info" button in the compiled HTML or check out the tables under the section headings in the PDF.
• Start filling out the .Rmd template by replacing _Put your text here._ with your information.
• Compile the .Rmd file to HTML (or PDF)
• Upload this preregistration protocol to a platform to make it publicly available with time stamp (e.g. osf.io, psycharchives.org)

FAQ

In PDF I want to get rid of the tables and R code!

Alrighty, no problem. Simply change

knitr::opts_chunk$set(echo = T, message = F, warning = F)

to

knitr::opts_chunk$set(echo = F, message = F, warning = F, eval = F)

This will keep the "more info" text in the PDF, but leave out the tables and R code. However, the first table on the differences compared to MARS, PROSPERO and PRISMA-P will still be visible.

Cite

Publication
Schneider, J., Backfisch, I., & Lachner, A. (2022). Facilitating Open Science Practices for Research Syntheses: PreregRS Guides Preregistration. Research Synthesis Methods, 13(2), 284–289. https://doi.org/10.1002/jrsm.1540

Presentation
Schneider, J., Backfisch, I., & Lachner, A. (2021). preregRS guides preregistration. Facilitating Open Science Practices for research syntheses. ZPID (Leibniz Institute for Psychology). https://doi.org/10.23668/PSYCHARCHIVES.4825

Financial Statement

Supported by the Federal Ministry of Education and Research, Germany.