diff --git a/DESCRIPTION b/DESCRIPTION index de17d61..59bb5d6 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -6,7 +6,8 @@ Authors@R: c( person("Frederik", "Aust", email = "frederik.aust@uni-koeln.de", role = c("aut", "cre"), comment = c(ORCID = "0000-0003-4900-788X")), person("Lisa", "Spitzer", email = "lisa.spitzer95@yahoo.de", role = "aut"), person("Jeffrey R.", "Stevens", email = "jeffrey.r.stevens@gmail.com", role = "ctb", comment = c(ORCID = "0000-0003-2375-1360")), - person("Masataka", "Ogawa", email = "ogawa@phiz.c.u-tokyo.ac.jp", role = "ctb") + person("Masataka", "Ogawa", email = "ogawa@phiz.c.u-tokyo.ac.jp", role = "ctb"), + person("Henry", "Kouker", email = "henry.samuel.kouker@gmail.com", role = "aut") ) Description: Provides a collection of templates to author preregistration documents for scientific studies in PDF format. URL: https://github.com/crsh/prereg diff --git a/inst/rmarkdown/templates/aspredicted_prereg/skeleton/skeleton.Rmd b/inst/rmarkdown/templates/aspredicted_prereg/skeleton/skeleton.Rmd index 8cd58bc..c8166e4 100644 --- a/inst/rmarkdown/templates/aspredicted_prereg/skeleton/skeleton.Rmd +++ b/inst/rmarkdown/templates/aspredicted_prereg/skeleton/skeleton.Rmd @@ -31,55 +31,65 @@ output: prereg::prereg_pdf **It's complicated.** We have already collected some data but explain in Question 8 why readers may consider this a valid **pre**-registration nevertheless. +## Data collection + -## Hypothesis - +**Yes**, we already collected the data. -> Example: A month-long academic summer program for disadvantaged kids will reduce the drop in academic performance that occurs during the summer. +**No**, no data have been collected for this study yet. +**It's complicated.** We have already collected some data but explain in Question 8 why readers may consider this a valid **pre**-registration nevertheless. + + + +## Hypothesis + -## Dependent variable - -> Example: Simple average GPA across all courses during the first semester after the intervention. +## Dependent variable + ## Conditions - + ## Analyses - - -> Example: Linear regression predicting the simple average GPA in the semester after the intervention with a dummy variable indicating whether the participant was offered the summer program or not (intention-to-treat analysis). We will also conduct the same regression controlling for simple average GPA during the semester before the intervention, gender, & household income (an 8-point scale ranging from 1 = below $20,000 and 8 = above $150,000). + ## Outliers and exclusions - + ## Sample size - + ## Other - + -> Example: We will include a battery of questions for exploratory purposes, including life satisfaction, amount of videogame playing, and family activity. We will also provide an additional survey with 24 questions assessing achievement orientation. We will not report the results of those analyses for the project being pre-registered. -> NOTE: If you leave this blank it will read 'Nothing else to pre-register.' +## Name + + +## Type of study * Class project or assignment * Experiment @@ -87,6 +97,15 @@ Finally. For record keeping purposes, please tell us the type of study you are p * Observational/archival study * Other: +## Data source + +* Prolific +* MTurk +* Cloud Research +* University lab +* Field experiment / RCT +* Other: + # References ## diff --git a/inst/rmarkdown/templates/cruewell_prereg/skeleton/skeleton.Rmd b/inst/rmarkdown/templates/cruewell_prereg/skeleton/skeleton.Rmd index b65b66b..ab62f8d 100644 --- a/inst/rmarkdown/templates/cruewell_prereg/skeleton/skeleton.Rmd +++ b/inst/rmarkdown/templates/cruewell_prereg/skeleton/skeleton.Rmd @@ -20,17 +20,35 @@ output: prereg::prereg_pdf # Study Information + ## Description +Example: While animals have been found to be able to reach optimality in the +speed-accuracy tradeoff, the evidence for humans is mixed. It is unclear whether +humans only do not act optimally by default, or whether they are unable to do so. Here, +we want to investigate this issue by giving participants time to practice, and varying the +amount of feedback they receive, to see if these affect whether they reach optimality in +the speed-accuracy tradeoff. +More info: Keep this description short – while it is helpful to give some context for your +project, you do not have to include a whole introductory section for the purposes of this +preregistration --> Enter your response here. -## Hypotheses - +## Hypotheses* + Enter your response here. @@ -39,68 +57,88 @@ Enter your response here. -## Dataset(s) - +## Dataset(s)* + Enter your response here. -## Publically available? +## Publically available?* **Yes** **No** -## Access +## Access* Enter your response here. -## Date of access - -Enter your response here. - - -## Data Source - +## Date of access/download* Enter your response here. -## Codebook - +## Data Source* + Enter your response here. -## Survey format - +## Codebook* + Enter your response here. -## Sampling and data collection - +## Sampling and data collection procedures* + Enter your response here. -## Prior work - +## Prior work based on the dataset* + Enter your response here. -## Prior research - - -Enter your response here. - - -## Prior knowledge - +## Prior Research Activity* + Enter your response here. @@ -109,77 +147,118 @@ Enter your response here. -## Data collection - - +## Data collection procedures* + + Enter your response here. -## Sample size - +## Sample size* + Enter your response here. ## Sample size rationale - + Enter your response here. ## Stopping rule - + Enter your response here. # Design Plan - - -## Study type - -**A. Experiment --- A researcher randomly assigns treatments to study subjects, this includes field or lab experiments. This is also known as an intervention experiment and includes randomized controlled trials.** - -**B. Observational Study - Data is collected from study subjects that are not randomly assigned to a treatment. This includes surveys, natural experiments, and regression discontinuity designs.** - -**C. Other** - -## Blinding - - -**A. No blinding is involved in this study.** - -**B. For studies that involve human subjects, they will not know the treatment group to which they have been assigned.** - -**C. Personnel who interact directly with the study subjects (either human or non-human subjects) will not be aware of the assigned treatments. (Commonly known as "double blind").** - -**D. Personnel who analyze the data collected from the study are not aware of the treatment applied to any given group.** + + +## Study type* + +A. Experiment - A researcher randomly assigns treatments to study subjects, this +includes field or lab experiments. This is also known as an intervention experiment +and includes randomized controlled trials. + +B. Observational Study - Data is collected from study subjects that are not randomly +assigned to a treatment. This includes surveys, natural experiments, and regression +discontinuity designs. + +C. Other + + +## Blinding* + +A. No blinding is involved in this study. +B. For studies that involve human subjects, they will not know the treatment group to +which they have been assigned. +C. Personnel who interact directly with the study subjects (either human or non-human +subjects) will not be aware of the assigned treatments. (Commonly known as +“double blind”) +D. Personnel who analyze the data collected from the study are not aware of the +treatment applied to any given group. --> ## Additional blinding - + Enter your response here. -## Experimental design +## Experimental design* +Example: We have a 3 (feedback: low, medium, high) by 2 (fixed time, fixed trial) by 23 +(practice block) design. +More info: This question has a variety of possible answers. The key is for a researcher +to be as detailed as is necessary given the specifics of their design --> Enter your response here. ## Randomization +Example: We will use block randomization, where each participant will be randomly +assigned to one of the four equally sized, predetermined blocks. The random number list +used to create these four blocks will be created using the web applications available at +http://random.org. +More info: If randomization is required for the study, the method should be specified +here, not simply the source of random numbers. --> Enter your response here. @@ -189,61 +268,116 @@ Enter your response here. ## Manipulated variables - + Enter your response here. -## Measured variables +## Measured variables* +Example: The outcome variables measured are reaction time and response accuracy. +More information: Observational studies will include only measured variables. As with +the previous questions, the answers here must be precise. --> Enter your response here. ## Indices - + Enter your response here. # Data Cleaning -## Data exclusion - +## Data exclusion* + Enter your response here. ## Missing data - + Enter your response here. # Cognitive modelling -## Cognitive model - +## Cognitive model* + Enter your response here. -## Parameter estimation +## Parameter estimation* +Example: Only Bayesian hierarchical modeling will be used to estimate the parameters +of the diffusion model, constraining individual-level parameters to follow group-level +truncated normal distributions. For the estimation model (see Figure 1, the two groups +(fixed-trial and fixed-time) are given a separate hierarchical structure, and the +group-level parameters are not constrained between groups. We will use likelihood +functions taken from the ``fast-dm'' toolbox (Voss & Voss, 2007) for the calculation of the +density function of the simple diffusion model. For the first model, for sampling from the +posterior distributions over parameters, we will use Markov-chain Monte Carlo with +differential evolution proposals (Turner et al., 2013), using 66 chains, drawing 3,000 +samples from each, and discarding the first 1,500 samples. +More information: If you are not interested in the parameters and are going straight to +statistical inference without estimating the parameters, please state this clearly and +motivate this choice. If you are using Bayesian methods, specify and motivate priors. In +general, specify as much as possible, including e.g. the starting point (distribution) for +estimation. If the data are going to be summarised into descriptive statistics, state which +descriptive statistics will be used, and how. --> Enter your response here. @@ -253,43 +387,126 @@ Enter your response here. ## Statistical analyses - + Enter your response here. ## Other analyses - + Enter your response here. ## Inference criteria - + Enter your response here. ## Exploratory analysis +Example: We are currently not planning any exploratory analyses. +More information: An exploratory test is any test where a prediction is not made up +front, or there are multiple possible tests that you are going to use. A statistically +significant finding in an exploratory test is a great way to form a new confirmatory +hypothesis, which could be registered at a later time. It is crucial to clearly distinguish +confirmatory from exploratory results in your final article. --> Enter your response here. -## Robustness checks/ sensitivity analyses - + +Enter your response here. + -This section ensures that robustness checks and parameter recovery simulations are not performed and/or reported selectively. It is important to note that, given the preregistration of modelling and analyses, it should be clear that any lack of robustness is at least not due to post-hoc, data-driven choices. --> +# Contingency plans + Enter your response here. -## Contingency plans - +# Other + +## Other (optional) + + +Enter your response here. # References diff --git a/inst/rmarkdown/templates/eeg_erg_prereg/skeleton/skeleton.Rmd b/inst/rmarkdown/templates/eeg_erg_prereg/skeleton/skeleton.Rmd new file mode 100644 index 0000000..19dc0eb --- /dev/null +++ b/inst/rmarkdown/templates/eeg_erg_prereg/skeleton/skeleton.Rmd @@ -0,0 +1,433 @@ +--- +title : "EEG ERP Preregistration Templatee" +shorttitle : "My preregistration" +date : "`r Sys.setlocale('LC_TIME', 'C'); format(Sys.time(), '%d\\\\. %B %Y')`" +author: + - name : First Author + affiliation : 1 + - name : Ernst-August Doelle + affiliation : "1,2" +affiliation: + - id : 1 + institution : Wilhelm-Wundt-University + - id : 2 + institution : Konstanz Business School + +output: prereg::prereg_pdf +--- + + + + +# Study Information + + + +## Description + + + +Enter your response here + +## Hypotheses* + + + +Enter your response here + +# Design Plan + + +## Stimuli* + + + +Enter your response here + +## Study design* + + + +Enter your response here + +## Randomization* + + + +Enter your response here + +## Blinding + + + +Enter your response here + +## Manipulation check + + + +Enter your response here + +## Existing data* + + + +Registration prior to creation of data: As of the date of submission of this research plan for preregistration, the data have not yet been collected, created, or realized. + +Registration prior to any human observation of the data: As of the date of submission, the data exist but have not yet been quantified, constructed, observed, or reported by anyone - including individuals that are not associated with the proposed study. An example could be data collected for a student project that has not been accessed yet. + +Registration prior to accessing the data: As of the date of submission, the data exist, but have not been accessed by you or your collaborators. Commonly, this includes data that has been collected by another researcher or institution. + +Registration prior to analysis of the data: As of the date of submission, the data exist and you have accessed it, though no analysis has been conducted related to the research plan (including calculation of summary statistics). A common situation is a large dataset that is used for many different studies over time, or when a data set is randomly split into a sample for exploratory analyses and the other section of data is reserved for later confirmatory data analysis. Another scenario for ERP research is that the data have been preprocessed but no ERP averages have been calculated yet. + +Registration following analysis of the data: As of the date of submission, you have accessed and analyzed some of the data relevant to the research plan. This includes preliminary analysis of variables, calculation of descriptive statistics, and observation of data distributions. +If this is the case, please indicate in your final paper that this is a preregistration after (part of the) data has been analyzed. + + + +## Explanation of existing data + + + +Enter your response here + +## Participant recruitment procedure + + + +Enter your response here + +## Sample size* + + + +Enter your response here + +## Sample size rationale* + + + +Enter your response here + +## Rationale for number of trials + + + +Enter your response here + +## Stopping rule + + + +Enter your response here + +# Variables + + + +## Manipulated variables* + + + +Enter your response here + +## Measured variables* + + + +Enter your response here + +## Indices + + + +Enter your response here + +# Acquisition + + +## Computer screen + + +Enter your response here + +## EEG hardware and acquisition settings* + + + +Enter your response here + +# Pre-processing + + + +## General Setup* + + + +Enter your response here + +## Data Import* + + + +Enter your response here + +## Resampling* + + + +Enter your response here + +## Re-Referencing* + + + +Enter your response here + +## Offline Filtering* + + + +Enter your response here + +## Artifact rejection/correction* + + + +Enter your response here + +## Epoching and averaging* + + + +Enter your response here + +## Baseline correction* + + + +Enter your response here + +# Analysis Plan + + + +## Statistical models* + + + +Enter your response here + +## Transformations + + + +Enter your response here + +## Inference criteria* + + + +Enter your response here + +## Data exclusion* + + + +Enter your response here + +## Missing data* + + + +Enter your response here + + +## Exploring your data + + + +Enter your response here + +# Other + + + +Enter your response here + + +## Supplementary materials (optional) + + +Enter your response here + +# References +## +\vspace{-2pc} +\setlength{\parindent}{-0.5in} +\setlength{\leftskip}{-1in} +\setlength{\parskip}{8pt} +\noindent diff --git a/inst/rmarkdown/templates/exp_sampling_prereg/skeleton/skeleton.Rmd b/inst/rmarkdown/templates/exp_sampling_prereg/skeleton/skeleton.Rmd new file mode 100644 index 0000000..d9f2229 --- /dev/null +++ b/inst/rmarkdown/templates/exp_sampling_prereg/skeleton/skeleton.Rmd @@ -0,0 +1,326 @@ +--- +title : "Preregistration of Experience-Sampling Studies" +shorttitle : "My preregistration" +date : "`r Sys.setlocale('LC_TIME', 'C'); format(Sys.time(), '%d\\\\. %B %Y')`" + +author: + - name : First Author + affiliation : 1 + - name : Second Author + affiliation : "1,2" + +affiliation: + - id : 1 + institution : First institution + - id : 2 + institution : Second institution + +output: prereg::prereg_pdf +--- + +# Study Information + + +## Description + + +Enter your response here + +## Hypotheses* + + +Enter your response here + + +# Design Plan + + + +## Study type* + + +Enter your response here + +## Blinding* + +*No blinding is involved in this study. +*Participants will not know the intervention group to which they have been assigned. +*Personnel who interact directly with the participants will not be aware of the assigned intervention group. (Commonly known as “double blind”) +*Personnel who analyze the data collected from the study are not aware ofthe intervention status of any given group. + +## additional blinding + +Enter your response here + +## Study design* + + +Enter your response here + + +# Sampling Plan + + +## Existing data* + +*Registration prior to creation of data: As of the date of submission of this research plan for pre-registration, the data have not yet been collected, created, or realized. +*Registration prior to any human observation of the data: As of the date of submission, the data exist but have not yet been quantified, constructed, observed, or reported by anyone - including individuals that are not associated with the proposed study. Examples include passively collecteddata from smartphones or wearables, e.g. location data, time spent using a particular app, and are inaccessible. +*Registration prior to accessing the data: As of the date of submission, the data exist, but have not been accessed by you or your collaborators. Commonly, this includes data that has been collected by another researcher or institution. +*Registration prior to analysis of the data: As of the date of submission, thedata exist and you have accessed it, though no analysis has been conducted related to the research plan (including calculation of summary statistics). A common situation for this scenario when a large dataset exists that is used for many different studies over time, or when a data setis randomly split into a sample for exploratory analyses, and the other section of data is reserved for later confirmatory data analysis. +*Registration following analysis of the data: As of the date of submission, you have accessed and analyzed some of the data relevant to the research plan. This includes preliminary analysis of variables, calculation of descriptive statistics, and observation of data distributions. Please see cos.io/prereg for more information. + + + +## Explanation of existing data + + +### Availablity + + +Enter your response here + +### Access of data + + +Enter your response here + +### date of download + + +Enter your response + +### documentation of data collection + + +Enter your response here + +### codebooks + + +Enter your response here + + +## ESM data collection procedure* + + +### study duration + + +Enter your response here + +### Type of sampling scheme + +Enter your response here + +### Details of the sampling scheme + + +Enter your response here + +### Type of sample scheme + + +Enter your response here + +### Items + + +Enter your response here + +### time-out specifications + + +Enter your response here + +### additional passive monitoring + + +Enter your response here + +### Incentivization + + +Enter your response here + +### additional details + + +Enter your response here + +## Sample size* + + +Enter your response here + +## Rationale for sample size + + +Enter your response here + +### more information + + +Enter your response here + +## Stopping rule + + +Enter your response here + +# Variables + + +## Measured non-ESM/time invariantvariables + + +Enter your response here + +## Measured ESM/time-variant variables* + + +Enter your response here + +## Open-ended questions + + +Enter your response here + +## Indices + + +Enter your resonse here + +## Manipulated variables + + +Enter your response here + +# Prior knowledge of data + + +Enter your response here + +## prior knowledge + + +Enter your response here + + +# Analysis Plan + + +## Statistical models* + +### type of statistical model + + +Enter your response here + + +### Distribution of the outcome variable + + +Enter your response here + + +### Distribution of the within-subject errors + + +Enter your response + + +### Distribution of the random effects + + +Enter your response here + + +### Fixed-effect predictors + + +Enter your response here + + +### Transformations + + +Enter your response here + + +### inclusion of lag-dependent variables + + +Enter your response here + +### more information +more information: please specify any interactions, subgroup analyses, pairwise or complex contrasts, or follow-up tests from omnibus tests. Remember that any test not included here must be noted as an exploratory test in your final article. +more information: This is perhaps the most important and most complicated question within the pre-registration. As with all of the other questions, the key is to provide a specific recipe for analyzing the collected data. Ask yourself, is enough detail provided to run the same analysis again? Be aware of instances where the statistical models appear specific, but actually leave openings for analytic flexibility. See the following examples: Example: If someone specifies a multilevel model with three time-varying predictors (X1, X2 and X3) and we are interested in estimating the effect of predictor X1, there is still flexibility over the specification. For example, does the model include a random slope for each of the three predictors? Does the model only consider a random slope for predictor X1? The two models produce differentestimates of the main effect of predictor X1. Example: The data has a three-level structure: repeated measurements (level 1)nested within days (level 2) and nested within an individual (level 3). If someone specifies a multilevel model with a random slope, there is still flexibility over the specification of the random effects: for example, the model includes a random intercept and a random slope that are allowed to vary within days and within individuals. Or the model includes a random intercept that is allowed to vary within days and within individuals and a random slope that is allowed to vary within individuals). These specifications imply different statistical models.--> + +Enter your response here + +## Analytic problem + + +Enter your response here + +## Transformations + + +Enter your response here + +## Inference criteria + + +Enter your response here + +## Missing data + + +Enter your respone here + +## Data exclusion + + +Enter your response here + +## Exploratory analysis + + +Enter your response here + + +# Other + +## Other + + +Enter your response here + + +# References +## +\vspace{-2pc} +\setlength{\parindent}{-0.5in} +\setlength{\leftskip}{-1in} +\setlength{\parskip}{8pt} +\noindent diff --git a/inst/rmarkdown/templates/multi_analyses_prereg/skeleton/skeleton.Rmd b/inst/rmarkdown/templates/multi_analyses_prereg/skeleton/skeleton.Rmd new file mode 100644 index 0000000..98cec97 --- /dev/null +++ b/inst/rmarkdown/templates/multi_analyses_prereg/skeleton/skeleton.Rmd @@ -0,0 +1,170 @@ +--- +title : "Preregistration of Multiverse Analyses" +shorttitle : "My preregistration" +date : "`r Sys.setlocale('LC_TIME', 'C'); format(Sys.time(), '%d\\\\. %B %Y')`" + +author: + - name : First Author + affiliation : 1 + - name : Second Author + affiliation : "1,2" + +affiliation: + - id : 1 + institution : First institution + - id : 2 + institution : Second institution + +output: prereg::prereg_pdf +--- + + + +# Preregistration guide + + +## Research question (construct-level) + + +Enter your response here + + +# Decisions + +## Covariates + + +Enter your response here + +## Causal model(s) + + +Enter your response here + +## Measurements of constructs + + +Enter your response here + +## Processing of measurements + + +Enter your response here + +## Sample composition + + +Enter your response here + +## Other decisions + + +Enter your response here + + +# Decision types + + + +## Statistical comparison of Type U decisions + + +Enter your response here + +## Organizing the multiverse + + +Enter your response here + + +# Model definitions + + +Enter your response here + + +# Criterion of interest + + +Enter your response here + + +# Interpretation and Decision process + + +Enter your response here + + +# References +## +\vspace{-2pc} +\setlength{\parindent}{-0.5in} +\setlength{\leftskip}{-1in} +\setlength{\parskip}{8pt} +\noindent diff --git a/inst/rmarkdown/templates/prp_quant_v3_prereg/skeleton/skeleton.Rmd b/inst/rmarkdown/templates/prp_quant_v3_prereg/skeleton/skeleton.Rmd new file mode 100644 index 0000000..bc5e0a4 --- /dev/null +++ b/inst/rmarkdown/templates/prp_quant_v3_prereg/skeleton/skeleton.Rmd @@ -0,0 +1,329 @@ +--- +title : "PRP-QUANT v3" +shorttitle : "My preregistration" +date : "`r Sys.setlocale('LC_TIME', 'C'); format(Sys.time(), '%d\\\\. %B %Y')`" + +author: + - name : First Author + affiliation : 1 + - name : Second Author + affiliation : "1,2" + +affiliation: + - id : 1 + institution : First institution + - id : 2 + institution : Second institution + +output: prereg::prereg_pdf +--- + + + +# Title + +## Contributors, Affiliations, and Persistent IDs + + +Enter your response here + + +## Time point of registration + +*Registration prior to creation/collection of data +*Registration prior to any human observation of the data (i.e., prior to anyone looking into the data) +*Registration prior to accessing the data (e.g., when conducting secondary data analysis) +*Registration prior to analysis of the data +*Other: +- Please specify: + + +## Versioning information + +* This is the first preregistration of this study. +* This is an updated version. +- Insert the link to the previous version below; this should be a persistent identifier such as a DOI: + + + +# Project Documentation + +## Estimated duration of project + + +Enter your response here + + +## Ethical considerations: Has appropriate institutional approval been obtained? + +*Yes +- Please provide the ID that has been assigned to your ethics proposal: .. +*Not yet but is planned +*Study will be exempt from ethical board review +- Please provide your reasoning: + +## Conflict of Interest Statement + +*All authors declare that they have no conflicts of interest in the conduct of this study. +*There is a potential conflict of interest. +- Please elaborate: + +## Software + + +Enter your response here + +## Will you use standard lab practices? + +*Yes +- If you have published your standard lab practices in a repository, you have received a persistent identifier (e.g., a DOI) that we ask you to enter here. Alternatively, you can also try to copy and paste your standard lab practice. +*No + +## Sharing level of your materials + + +Analysis code +* as public use file +* as scientific use file +* on case basis +* via secure data center +* per email request +* none +* not applicable + +Raw data +* as public use file +* as scientific use file +* on case basis +* via secure data center +* per email request +* none +* not applicable + +Experimental code +* as public use file +* as scientific use file +* on case basis +* via secure data center +* per email request +* none +* not applicable + +Processed data +* as public use file +* as scientific use file +* on case basis +* via secure data center +* per email request +* none +* not applicable + +## Planned repositories + + +Enter your response here + +## Other information + + +Enter your response here + + +# Abstract + +## Abstract + + +Enter your response here + +## Keywords + + +Enter your response here + +# Introduction + +## Theoretical background + + +Enter your response here + +## Objectives and Research question(s) + + +Enter your response here + +## Hypotheses (H1, H2, …) + + +Enter your response here + +## Exploratory research questions (if applicable; E1, E2, ....) + + +Enter your response here + + +# Method + + +## Pre-existing data: Publication status, source, and knowledge + + +Enter your response here + +## Piloting + + +Enter your response here + +## Sample size justification + + +Enter your response here + +## Participant recruitment, selection, and compensation + + +Enter your response here + +## How will participant drop-out be handled? + + +Enter your response here + +## Masking of participants and researchers + + +Enter your response here + +## Other information + + +Enter your response here + +## Type of study and study design + + +Enter your response here + +## Randomization of participants and/or experimental materials + + +Enter your response here + +## Measured variables, manipulated variables, covariates + + +Enter your response here + +## Exhaustiveness of variables + +* All variables of the planned study are outlined here and their roles are clearly defined. +* Our planned study includes additional variables that are not listed here. +- Please explain why not all variables are listed above: + +## Study Materials + + +Enter your response here + +## Study Procedures + + +Enter your response here + +## Other information + + +Enter your response here + + +# Analysis plan + + +## Criteria for post-data collection exclusion of participants + + +Enter your response here + +## Criteria for post-data collection exclusions on trial level + + +Enter your response here + +## Exhaustiveness of exclusion criteria + +* All exclusion criteria (on the participant and trial level) that are currently planned are listed above. +* Not all exclusion criteria are listed above. +- Please explain why some exclusion criteria are not described: + +## Data preprocessing + + +Enter your response here + +## Data cleaning and screening + + +Enter your response here + +## How will missing data be handled? + + +Enter your response here + +## Reliability analysis (if applicable) + + +Enter your response here + +## Descriptive statistics + + +Enter your response here + +## Statistical models + + +Enter your response here + +## Inference criteria + + +Enter your response here + +## Exploratory analysis + + +Enter your response here + +## Other information + + +Enter your response here + +# References +## +\vspace{-2pc} +\setlength{\parindent}{-0.5in} +\setlength{\leftskip}{-1in} +\setlength{\parskip}{8pt} +\noindent diff --git a/inst/rmarkdown/templates/qualitative_study_prereg/skeleton/skeleton.Rmd b/inst/rmarkdown/templates/qualitative_study_prereg/skeleton/skeleton.Rmd new file mode 100644 index 0000000..26997b2 --- /dev/null +++ b/inst/rmarkdown/templates/qualitative_study_prereg/skeleton/skeleton.Rmd @@ -0,0 +1,177 @@ +--- +title : "My preregistration for a qualitative study based on Haven et al. (2020) template" +shorttitle : "My preregistration" +date : "`r Sys.setlocale('LC_TIME', 'C'); format(Sys.time(), '%d\\\\. %B %Y')`" + +author: + - name : First Author + affiliation : 1 + - name : Second Author + affiliation : "1,2" + +affiliation: + - id : 1 + institution : First institution + - id : 2 + institution : Second institution + +output: prereg::prereg_pdf +--- + +# Study Information + +## Researcher background + + + +Enter your response here. + + +## Duration + +Project start date: + +Estimated project end date: + + + + +## Research Aim + + +Enter your response here. + + +## Research Question(s) + + +Enter your response here. + + +## Theoretical expectations + + +Enter your response here. + + +## Hypotheses + + +Enter your response here. + + +# Design Plan + +## Study Type + + +Enter your response here. + + +## Tradition + + +Enter your response here. + + +## Sort of sample + + +Enter your response here. + + +## Sampling strategy + + +Enter your response here. + + +# Data Collection + +## Origin of data + + +Enter your response here. + + +## Type of Data + + +Enter your response here. + + +## Data Collection Procedures + + +Enter your response here. + + +## Data collection plan + + +Enter your response here. + + +## Sampling Rationale + + +Enter your response here. + + +## Stopping Rule + + +Enter your response here. + + +# Analysis Plan + +## Data Analysis + + +Enter your response here. + + +## Evidence criteria + + +Enter your response here. + + +## Weight of evidence + + +Enter your response here. + + +## Data analysis explained + + +Enter your response here. + + +## Data validation + + +Enter your response here. + + +# References +## +\vspace{-2pc} +\setlength{\parindent}{-0.5in} +\setlength{\leftskip}{-1in} +\setlength{\parskip}{8pt} +\noindent diff --git a/inst/rmarkdown/templates/scoping_reviews_prereg/skeleton/skeleton.Rmd b/inst/rmarkdown/templates/scoping_reviews_prereg/skeleton/skeleton.Rmd new file mode 100644 index 0000000..1cac50d --- /dev/null +++ b/inst/rmarkdown/templates/scoping_reviews_prereg/skeleton/skeleton.Rmd @@ -0,0 +1,194 @@ +--- +title : "Preregistration Template for Scoping Reviews" +shorttitle : "My preregistration" +date : "`r Sys.setlocale('LC_TIME', 'C'); format(Sys.time(), '%d\\\\. %B %Y')`" + +author: + - name : First Author + affiliation : 1 + - name : Second Author + affiliation : "1,2" + +affiliation: + - id : 1 + institution : First institution + - id : 2 + institution : Second institution + +output: prereg::prereg_pdf +--- + + +# Title + + +## Contributors, Affiliations, and Persistent IDs (recommend ORCID iD) + + +Enter your response here + +## Date of Preregistration + + +Enter your response here + +## Project stage at registration + + +Enter your response here + +## Anticipated start date + + +Enter your response here + +## Estimated duration of project + + +Enter your response here + +## Optional: IRB Status + + +Enter your response here + +## Conflict of Interest Statement + + +Enter your response here + +## Keywords + + +Enter your response here + +## Data accessibility statement and planned repository + +* We plan to make the data available (yes / no) + + + +* Data access via download; usage of data for all purposes (public use file) +* Data access via download; usage of data restricted to scientific purposes (scientific use file) +* Data access via download; usage of data has to be agreed and defined on an +individual case basis +* Data access via secure data center (no download, usage/analysis only in a secure +data center) +* Data available upon email request by member of scientific community +* Other (please specify) + + +## Optional: Code availability + + +Enter your response here + +## Optional: Standard lab practices + + +Enter your response here + +## Funding + + +Enter your response here + + +# Abstract + +## Structured summary + + +Enter your respone here + + +# Introduction + + +## Rationale + + +Enter your respone here + +## Objectives + + +Enter your respone here + + +# Methods + +## Eligibility criteria + + +Enter your respone here + +## Information sources + + +Enter your respone here + +## Search + + +Enter your respone here + +## Selection of sources of evidence + + +Enter your respone here + +# Data charting process + + +Enter your respone here + +## Data items + + +Enter your respone here + +## Critical appraisal of individual sources of evidence + + +Enter your respone here + +## Synthesis of results + + +Enter your respone here + + +# Other information optional + + + +## Other information + + +Enter your respone here + + +# References +## +\vspace{-2pc} +\setlength{\parindent}{-0.5in} +\setlength{\leftskip}{-1in} +\setlength{\parskip}{8pt} +\noindent diff --git a/inst/rmarkdown/templates/secondary_data_analysis_prereg/skeleton/skeleton.Rmd b/inst/rmarkdown/templates/secondary_data_analysis_prereg/skeleton/skeleton.Rmd new file mode 100644 index 0000000..a7c0059 --- /dev/null +++ b/inst/rmarkdown/templates/secondary_data_analysis_prereg/skeleton/skeleton.Rmd @@ -0,0 +1,220 @@ +--- +title : "My preregistration of a secondary data analysis" +shorttitle : "My preregistration" +date : "`r Sys.setlocale('LC_TIME', 'C'); format(Sys.time(), '%d\\\\. %B %Y')`" + +author: + - name : First Author + affiliation : 1 + - name : Second Author + affiliation : "1,2" + +affiliation: + - id : 1 + institution : First institution + - id : 2 + institution : Second institution + +output: prereg::prereg_pdf +--- + + + +# Part 1: Study information + +## Study title + + +Enter your response here. + + +## Authors + + +Enter your response here. + + +## Research questions + + +Enter your response here. + + +## Hypotheses and rationale + + +Enter your response here. + + +# Part 2: Data description + +## Dataset description + + +Enter your response here. + + +## Openness and availability of the data + + +Enter your response here. + + + + +## How to access the data + + +Enter your response here. + + + + +## Date of download and access + + +Enter your response here. + + + + +## Data collection procedure + + +Enter your response here. + + + + +## Codebook and documentation + + +Enter your response here. + + +# Part 3: Variables + +## Manipulated variables + + +Enter your response here. + + +## Measured variables (outcomes, predictors, covariates) + + +Enter your response here. + + + + +## Inclusion and exclusion criteria; initial sample size + + +Enter your response here. + + + + +## Missing data and updated sample size + + +Enter your response here. + + + + +## Outliers and final sample size + + +Enter your response here. + + + + +## Sampling weights + + +Enter your response here. + + +# Part 4: Knowledge of data + +## Previous work with this dataset + + +Enter your response here. + + + + +## Prior knowledge relevant to this analysis + + +Enter your response here. + + +# Part 5: Analyses + +## Statistical models + + +Enter your response here. + + +## Effect sizes of interest + + +Enter your response here. + + + + +## Power or precision + + +Enter your response here. + + + + +## Inference criteria + + +Enter your response here. + + +## Handling assumption violations and analytic problems + + +Enter your response here. + + + + +## Robustness and sensitivity analyses + + +Enter your response here. + + + + +## Exploratory analyses + + +Enter your response here. + + +# Part 6: Statement of integrity +The authors of this preregistration state that they have filled out this preregistration +to the best of their knowledge and that no other preregistration exists pertaining +to the same hypotheses and dataset. + +# References +## +\vspace{-2pc} +\setlength{\parindent}{-0.5in} +\setlength{\leftskip}{-1in} +\setlength{\parskip}{8pt} +\noindent diff --git a/inst/rmarkdown/templates/vantveer_prereg/skeleton/skeleton.Rmd b/inst/rmarkdown/templates/vantveer_prereg/skeleton/skeleton.Rmd index 4abe66e..9690766 100644 --- a/inst/rmarkdown/templates/vantveer_prereg/skeleton/skeleton.Rmd +++ b/inst/rmarkdown/templates/vantveer_prereg/skeleton/skeleton.Rmd @@ -17,54 +17,64 @@ affiliation: output: prereg::prereg_pdf --- + # Hypotheses -## Predictions - +## Description of essential elements* + Enter your response here. -## Rationale (optional) - +## Recommended elements + + 1. For original research, add rationales or theoretical frameworks for why a certain hypothesis is tested. + 2. If multiple predictions can be made for the same IV-DV combination, describe what outcome would be predicted by which theory. --> Enter your response here. -## Planned sample - +# Methods -Enter your response here. +## Design* + +Enter your response here -## Exclusion criteria - +## Planned Sample* + -Enter your response here. +Enter your response here +## Exclusion Criteria* + -## Procedure - +Enter your response here - +## Procedure* + Enter your response here. @@ -72,46 +82,47 @@ Enter your response here. # Analysis plan ## Confirmatory analyses - + Enter your response here. -## Details of analysis - +## Recommended Elements + Enter your response here. ## Existing data - - -**Data collection has not begun.** - -**Data collection is underway or complete but I have not yet looked at the data.** - -**Data collection is underway or complete and I have looked at the data.** + + 1. No, data collection has not begun + 2. Yes, data collection is underway or complete. + + 1. Yes + 2. No -## Project schedule (optional) +## Project schedule Enter your response here. -## Further comments (optional) +## Further comments Enter your response here.