Skip to content

Commit 72152db

Browse files
committed
enh : complete information about the sections about and methods
1 parent f2981fe commit 72152db

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

docs/users/howto_read_fmriprep_visual_report.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -169,9 +169,6 @@ The brain edge (or crown) ROI (green contour) picks signals outside but close to
169169
### Variance explained by t/a CompCor components
170170

171171
The figure displays the cumulative variance explained by components for each of four CompCor decompositions (left to right: anatomical CSF mask, anatomical white matter mask, anatomical combined mask, temporal). Dotted lines indicate the minimum number of components necessary to explain 50%, 70%, and 90% of the variance in the nuisance mask. By default, only the components that explain the top 50% of the variance are saved. The number of components that must be included in the model in order to explain some fraction of variance in the decomposition mask can be used as a feature selection criterion for confound regression.
172-
173-
* Good:
174-
* Bad:
175172

176173
### BOLD summary
177174

@@ -206,11 +203,12 @@ What you’re looking at:
206203
* Link to documentation on confounds: <https://fmriprep.readthedocs.io/en/stable/outputs.html#confounds>
207204

208205
## About
206+
This section is a textual summary, containing the version of fMRIPrep, which command was run and the dates when the data were preprocessed. It is good to check that all of this information is as expected.
209207

210208
## Methods
211-
212-
## Errors
209+
This section provides a boilerplate describing in detail the preprocessing of the images. We kindly ask to report results preprocessed with fMRIPrep using that boilerplate. The latter is available in three languages (HTML, Markdown and Latex) to faciliate integration in manuscripts.
213210

211+
## Errors
214212
This section tells you whether fMRIPrep encountered any problems during the preprocessing. Note that “errors” refers only to problems in running fMRIPrep, and NOT problems with the quality of the resulting images. This section won’t flag participants in which fMRIPrep was able to successfully run to completion but yielded poor results, or in which the input data was of lower-than-desirable quality.
215213

216214
## Things that aren’t an issue

0 commit comments

Comments
 (0)