Skip to content

Commit 566592a

Browse files
authored
DOC: Document freesurfer parameter in BOLD confound workflow init (#3504)
## Changes proposed in this pull request Document `freesurfer` parameter in BOLD confound workflow initialization function. Take advantage of the commit to move the `name` parameter docstring after `freesurfer` to match the function signature. ## Documentation that should be reviewed `init_bold_confs_wf` function.
2 parents 2f86d96 + 2b8febd commit 566592a

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

fmriprep/workflows/bold/confounds.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,8 +105,6 @@ def init_bold_confs_wf(
105105
the FoV
106106
metadata : :obj:`dict`
107107
BIDS metadata for BOLD file
108-
name : :obj:`str`
109-
Name of workflow (default: ``bold_confs_wf``)
110108
regressors_all_comps : :obj:`bool`
111109
Indicates whether CompCor decompositions should return all
112110
components instead of the minimal number of components necessary
@@ -115,6 +113,11 @@ def init_bold_confs_wf(
115113
Criterion for flagging DVARS outliers
116114
regressors_fd_th : :obj:`float`
117115
Criterion for flagging framewise displacement outliers
116+
freesurfer : :obj:`bool`
117+
Set to ``True`` if the input volume fractions for the anatomical
118+
component-based noise correction maps come from FreeSurfer's ``aseg``.
119+
name : :obj:`str`
120+
Name of workflow (default: ``bold_confs_wf``)
118121
119122
Inputs
120123
------

0 commit comments

Comments
 (0)