juaml/junifer
Watch
3
0
Fork
You've already forked junifer
 0
Code Issues 14 Pull requests 2 Packages Activity Actions

[DOC]: Add missing types in DataGrabber types docstrings #330

Merged
synchon merged 2 commits from chore/missing-type-docs into main 2024-04-30 10:09:51 +00:00
Conversation 3 Commits 2 Files changed 5 +13 -8
5 changed files with 13 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

1
docs/changes/newsfragments/330.doc Normal file
View file

@ -0,0 +1 @@
Add missing DataGrabber ``types`` options in respective docstrings of :class:`.DataladAOMICID1000`, :class:`.DataladAOMICPIOP1`, :class:`.DataladAOMICPIOP2` and :class:`.DMCC13Benchmark` by `Synchon Mandal`_

5
junifer/datagrabber/aomic/id1000.py
View file

@ -24,8 +24,9 @@ class DataladAOMICID1000(PatternDataladDataGrabber):
The directory where the datalad dataset will be cloned. If None, The directory where the datalad dataset will be cloned. If None,
the datalad dataset will be cloned into a temporary directory the datalad dataset will be cloned into a temporary directory
(default None). (default None).
types: {"BOLD", "BOLD_confounds", "T1w", "VBM_CSF", "VBM_GM", \ types: {"BOLD", "BOLD_confounds", "BOLD_mask", "T1w", "T1w_mask", \
"VBM_WM", "DWI"} or a list of the options, optional "VBM_CSF", "VBM_GM", "VBM_WM", "DWI"} or \
a list of the options, optional
AOMIC data types. If None, all available data types are selected. AOMIC data types. If None, all available data types are selected.
(default None). (default None).
native_t1w : bool, optional native_t1w : bool, optional

5
junifer/datagrabber/aomic/piop1.py
View file

@ -26,8 +26,9 @@ class DataladAOMICPIOP1(PatternDataladDataGrabber):
The directory where the datalad dataset will be cloned. If None, The directory where the datalad dataset will be cloned. If None,
the datalad dataset will be cloned into a temporary directory the datalad dataset will be cloned into a temporary directory
(default None). (default None).
types: {"BOLD", "BOLD_confounds", "T1w", "VBM_CSF", "VBM_GM", \ types: {"BOLD", "BOLD_confounds", "BOLD_mask", "T1w", "T1w_mask", \
"VBM_WM", "DWI"} or a list of the options, optional "VBM_CSF", "VBM_GM", "VBM_WM", "DWI"} or \
a list of the options, optional
AOMIC data types. If None, all available data types are selected. AOMIC data types. If None, all available data types are selected.
(default None). (default None).
tasks : {"restingstate", "anticipation", "emomatching", "faces", \ tasks : {"restingstate", "anticipation", "emomatching", "faces", \

5
junifer/datagrabber/aomic/piop2.py
View file

@ -26,8 +26,9 @@ class DataladAOMICPIOP2(PatternDataladDataGrabber):
The directory where the datalad dataset will be cloned. If None, The directory where the datalad dataset will be cloned. If None,
the datalad dataset will be cloned into a temporary directory the datalad dataset will be cloned into a temporary directory
(default None). (default None).
types: {"BOLD", "BOLD_confounds", "T1w", "VBM_CSF", "VBM_GM", \ types: {"BOLD", "BOLD_confounds", "BOLD_mask", "T1w", "T1w_mask", \
"VBM_WM", "DWI"} or a list of the options, optional "VBM_CSF", "VBM_GM", "VBM_WM", "DWI"} or \
a list of the options, optional
AOMIC data types. If None, all available data types are selected. AOMIC data types. If None, all available data types are selected.
(default None). (default None).
tasks : {"restingstate", "stopsignal", "workingmemory"} \ tasks : {"restingstate", "stopsignal", "workingmemory"} \

5
junifer/datagrabber/dmcc13_benchmark.py
View file

@ -25,8 +25,9 @@ class DMCC13Benchmark(PatternDataladDataGrabber):
The directory where the datalad dataset will be cloned. If None, The directory where the datalad dataset will be cloned. If None,
the datalad dataset will be cloned into a temporary directory the datalad dataset will be cloned into a temporary directory
(default None). (default None).
types: {"BOLD", "BOLD_confounds", "T1w", "VBM_CSF", "VBM_GM", \ types: {"BOLD", "BOLD_confounds", "BOLD_mask", "T1w", "T1w_mask", \
"VBM_WM"} or a list of the options, optional "VBM_CSF", "VBM_GM", "VBM_WM", "Warp" (only if \
"native_t1w = True")} or a list of the options, optional
DMCC data types. If None, all available data types are selected. DMCC data types. If None, all available data types are selected.
(default None). (default None).
sessions: {"ses-wave1bas", "ses-wave1pro", "ses-wave1rea"} or list of \ sessions: {"ses-wave1bas", "ses-wave1pro", "ses-wave1rea"} or list of \