Skip to content

Commit f66e414

Browse files
committed
update documentation
1 parent 1aee771 commit f66e414

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

nipype/interfaces/afni/preprocess.py

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1826,7 +1826,8 @@ class ROIStatsInputSpec(CommandLineInputSpec):
18261826
zerofill = traits.Str(
18271827
requires=['num_roi'],
18281828
desc='For ROI labels not found, use the provided string instead of '
1829-
'a \'0\' in the output file. Only active if zerofill is active.',
1829+
'a \'0\' in the output file. Only active if `num_roi` is '
1830+
'enabled.',
18301831
argstr='-zerofill %s')
18311832
roisel = traits.File(
18321833
exists=True,
@@ -1908,11 +1909,14 @@ class ROIStats(AFNICommandBase):
19081909
19091910
>>> from nipype.interfaces import afni
19101911
>>> roistats = afni.ROIStats()
1911-
>>> roistats.inputs.in_file = 'functional.nii'
1912-
>>> roistats.inputs.mask = 'skeleton_mask.nii.gz'
1913-
>>> roistats.inputs.quiet = True
1912+
>>> roistats.inputs.in_file = 'func.nii'
1913+
>>> roistats.inputs.mask_file = 'label-schaefer400_atlas.nii.gz'
1914+
>>> roistats.inputs.stat = ['mean', 'median', 'voxels']
1915+
>>> roistats.inputs.nomeanout = True
19141916
>>> roistats.cmdline
1915-
'3dROIstats -quiet -mask skeleton_mask.nii.gz functional.nii'
1917+
'3dROIstats -quiet -mask label-schaefer400_atlas.nii.gz \
1918+
-nzmean -nzmedian -nzvoxels -nomeanout func.nii \
1919+
> func_roistat.1D'
19161920
>>> res = roistats.run() # doctest: +SKIP
19171921
19181922
"""

0 commit comments

Comments
 (0)