The R Markdown templates in this package are based on the Center for Open Science Preregistration Challenge and the 'AsPredicted.org' questions. They are, thus, particularly suited to draft preregistration documents for these programs but can also be used for internally.
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 and the AsPredicted.org questions. They are, thus, particularly suited to draft preregistration documents for studies these programs but can also be used for internal preregistrations.
If you experience any problems or have suggestions for improvements, please open an issue.
To use R Markdown and
prereg you need the following software on your computer:
You can install the stable version of
prereg from CRAN
or the development version from this GitHub repository (you may have to install the
devtools package first).
Once you have installed the
prereg you can select the templates when creating a new R Markdown file through the RStudio menus.
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.
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 filermarkdown::draft("my_preregistration.Rmd", "cos_prereg", package = "prereg", create_dir = FALSE, edit = FALSE)# Render documentrmarkdown::render("my_preregistration.Rmd")