Conversation
I updated the template by using the latest version of the orignial template
changed a few things so the r template is closer to the original
There was a problem hiding this comment.
Hi Henry, thanks, this is great. The added detail in the description of the items will be very helpful, especially the examples. I have added some comments and requested a few changes. Would you be willing to revise your PR?
Also, before we merge your changes, you may consider adding yourself as a contributor to the DESCRIPTION file.
-I have implemented the comments -Required → * -Errors fixed
vantveer prereg -Comments implemented -Required → *
update to the latest as predicted_prereg version Some formatting changes to ensure consistency with the other templates
I changed <-- to <!--
I forgot to add a few exclamation marks in the code
new template suggestion
new template suggestion
new template suggestion
new template suggestion
new template suggestion
new template suggestion
added the latest version of the prp quant template
|
This pull request implements the requested comments and fixes remaining errors. |
formatting changes
i -> 1 ii -> 2 etc.
crsh
left a comment
crsh
left a comment
There was a problem hiding this comment.
Thanks for this. I have added some more comments.
For the newly added templates (e.g., QRP-QUANT), please make sure that the folder structure is analogous to those of the other templates. Specifically:
- Each template needs to go into a subfolder of
inst/rmarkdown/templates, these should be in all lower case and adhere to the conventions of previous templates. For example for the EEG-template: `eeg_erp_prereg`` - The template files themselves should be names
skeleton.Rmd
| output: prereg::prereg_pdf | ||
| --- | ||
|
|
||
| ```{r setup, include=FALSE} |
|
|
||
| ## Duration | ||
|
|
||
| Project start date: |
There was a problem hiding this comment.
Can you add an empty line between the two? Otherwise they will be rendered on a the same line.
| output: prereg::prereg_pdf | ||
| --- | ||
|
|
||
| ```{r setup, include=FALSE} |
| ## Covariates | ||
| <!-- | ||
| 1. What are other constructs that are involved in, or somehow affect, the associations of interest? | ||
| * These could be mediators, moderators, confounds, or constructs that impact the effects, even if they don’t impact the causes |
There was a problem hiding this comment.
Would it make sense to indent these *-bullet points?
| 4. Are there moderators of the cause’s impact on the effect, i.e., are there constructs that change how much the cause impacts the effect? | ||
| 5. If you (and theory, and the literature) are uncertain about what role a construct plays, it is likely there are competing causal models. | ||
| 6. Write out all reasonable, plausible, causal models. It may be helpful to create a diagram in a graphical program (InkScape, LucidChart, PowerPoint, Adobe Illustrator) or using the ggdag package in R.--> | ||
| Enter your response here |
There was a problem hiding this comment.
Please add a new line between comment and "Enter your response here". While you are at it, also see this applies anywhere in the rest of the document.
| purpose of the study (e.g., whether it is a replication), or broad research questions. | ||
| Example: We will test whether the mismatch negativity (MMN) is modulated by pitch differences differently in people with and without musical training. We will present a group of musicians and a group of non-musicians with tones in an oddball paradigm. The difference between the standard and the deviant tone will be either small (4 Hz) or large (8 Hz). We collect EEG data as well as behavioral accuracy in detecting the oddball as measured by a button-press. | ||
| More info: The description should be no longer than the length of an abstract. It can give some context for the proposed study, but great detail is not needed here for your preregistration.--> | ||
|
|
There was a problem hiding this comment.
"Enter your response here" is missing.
| * We will consider a large candidate ROI over left motor cortex, including Cz, C1, C3, CPz, CP1, CP3, Pz, P1, P3, and select those electrodes that showed a robust modulation by left vs. right hand responses at p < .05, paired t-test" | ||
| * Collapsed localizer: “We will select the 4 electrodes with the largest MMN between 50 and 250 ms on the grand average data” | ||
| * No selection of channels necessary: e.g., mass-univariate, ICA/PCA, source-space, cluster-based permutation tests | ||
| 18.5. More information on time windows: Non-exhaustive list of examples: |
There was a problem hiding this comment.
What is the meaning of the 18.5.? Do we need this?
|
|
||
| <!-- If any measurements are going to be combined into an index (or even a | ||
| mean), what measures will you use and how will they be combined? Include either a formula or a precise description of your method. If you are using a more complicated statistical method to combine measures (e.g., factor analysis, z-standardization within conditions/participants), you can note that here but describe the exact method in the analysis plan section. Also include the time window and region of interest over which the index will be computed. | ||
| Example: We will compute the mean amplitude based on the above specified time window (50-250 ms) and electrodes (Fz, FCz, Cz) (see section 18).--> |
There was a problem hiding this comment.
There is a reference here to section 18; I don't think we have a section 18 here, right?
| output: prereg::prereg_pdf | ||
| --- | ||
|
|
||
| ```{r setup, include=FALSE} |
| Enter your response here | ||
|
|
||
| ## Explanation of existing data | ||
| <!--8.1.Name and briefly describe the data set(s), and if applicable, the subset(s) of the data you plan to use.Example: The current study will use a subset of variables (see variables section for names) from Wave I of the RE-AL cohort study, using data from all participants within the dataset (N=220). |
There was a problem hiding this comment.
For these types of items, can you please remove the top-level numbering (8.) and place the sub-items as level-3 headings outside of the comments (e.g., ### Specify whether this data is open or publicly available) with the subsequent information as comments (e.g. `
There was a problem hiding this comment.
This applies to several items in this template.
…nst/rmarkdown/templates/eeg_erg_prereg/skeleton.Rmd
…markdown/templates/eeg_erg_prereg/skeleton/skeleton.Rnd
…tes/prp_quant_v3_prereg/skeleton/skeleton.Rmd
…/templates/prereg_exp_sampling/skeleton/skeleton.Rmd
…Reviews to inst/rmarkdown/templates/scoping_reviews_prereg/skeleton/skeleton.Rmd
…s to inst/rmarkdown/templates/multi_analyses_prereg/skeleton/skeleton.Rmd
…lysis: A template to inst/rmarkdown/templates/secondary_data_analysis_prereg/skeleton/skeleton.Rmd
… to inst/rmarkdown/templates/qualitative_study_prereg/skeleton/skeleton.Rmd
removed chunk and formatting changes
chunk removed # formatting changes
implemented commets
implemented the comments
implemented comments
implemented comments
implemented comments(not all of them yet)
|
I implemented most of the suggestions. I still need to change the numbering to level-3 headings in the exp_sampling_prereg template. In addition, I will double-check that the formatting is consistent across all templates. |
formatting changes
2 participants
I updated the templates so they are more similar to the originals