Skip to content

Commit 1dca11a

Browse files
committed
DOC: Update ExpandModel.inputs.model_formula docstring to suppress warning
1 parent 8422b57 commit 1dca11a

File tree

1 file changed

+19
-16
lines changed

1 file changed

+19
-16
lines changed

niworkflows/interfaces/confounds.py

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -35,22 +35,25 @@ class _ExpandModelInputSpec(BaseInterfaceInputSpec):
3535
a single variable (e.g., (x)^2, not x^2).
3636
3737
Examples:
38-
* rps + wm + csf + gsr : 9-parameter model. rps denotes realignment
39-
parameters, wm denotes mean white matter signal, csf denotes mean
40-
cerebrospinal fluid signal, and gsr denotes mean global signal.
41-
* (dd1(rps + wm + csf + gsr))^^2 : 36-parameter expansion.
42-
rps + wm + csf + gsr denotes that realignment parameters and mean
43-
WM, CSF, and global signals should be included. dd1 denotes that
44-
these signals should be augmented with their first temporal
45-
derivatives. ^^2 denotes that the original signals and temporal
46-
derivatives should be augmented with quadratic expansions.
47-
* (dd1(rps))^^2 : 24-parameter expansion. rps denotes that
48-
realignment parameters should be included. dd1 and ^^2 denote
49-
temporal derivative and quadratic expansions as above.
50-
* (dd1(rps + wm + csf + gsr))^^2 + others : generate all expansion
51-
terms necessary for a 36-parameter model as above, and
52-
concatenate those expansion terms to all other regressor columns
53-
in the confounds file.""",
38+
39+
* rps + wm + csf + gsr : 9-parameter model. rps denotes realignment
40+
parameters, wm denotes mean white matter signal, csf denotes mean
41+
cerebrospinal fluid signal, and gsr denotes mean global signal.
42+
* (dd1(rps + wm + csf + gsr))^^2 : 36-parameter expansion.
43+
rps + wm + csf + gsr denotes that realignment parameters and mean
44+
WM, CSF, and global signals should be included. dd1 denotes that
45+
these signals should be augmented with their first temporal
46+
derivatives. ^^2 denotes that the original signals and temporal
47+
derivatives should be augmented with quadratic expansions.
48+
* (dd1(rps))^^2 : 24-parameter expansion. rps denotes that
49+
realignment parameters should be included. dd1 and ^^2 denote
50+
temporal derivative and quadratic expansions as above.
51+
* (dd1(rps + wm + csf + gsr))^^2 + others : generate all expansion
52+
terms necessary for a 36-parameter model as above, and
53+
concatenate those expansion terms to all other regressor columns
54+
in the confounds file.
55+
56+
""",
5457
)
5558
output_file = File(desc="Output path")
5659

0 commit comments

Comments
 (0)