Skip to content

Commit 1830b25

Browse files
authored
Merge pull request #2223 from effigies/enh/derivatives
ENH: Conform to BIDS Derivatives as of BIDS 1.4.0
2 parents 95f12b9 + 3e14bd4 commit 1830b25

File tree

13 files changed

+79
-57
lines changed

13 files changed

+79
-57
lines changed

.circleci/ds005_fasttrack_outputs.txt

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
fmriprep
2+
fmriprep/.bidsignore
23
fmriprep/dataset_description.json
34
fmriprep/desc-aparcaseg_dseg.tsv
45
fmriprep/desc-aseg_dseg.tsv
@@ -10,8 +11,8 @@ fmriprep/logs/CITATION.tex
1011
fmriprep/sub-01
1112
fmriprep/sub-01/func
1213
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-1_AROMAnoiseICs.csv
13-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-1_desc-confounds_regressors.json
14-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-1_desc-confounds_regressors.tsv
14+
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-1_desc-confounds_timeseries.json
15+
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-1_desc-confounds_timeseries.tsv
1516
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-1_desc-MELODIC_mixing.tsv
1617
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-1_from-scanner_to-T1w_mode-image_xfm.txt
1718
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-1_from-T1w_to-scanner_mode-image_xfm.txt
@@ -44,8 +45,8 @@ fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-1_space-T1w_desc-brain_mas
4445
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-1_space-T1w_desc-preproc_bold.json
4546
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-1_space-T1w_desc-preproc_bold.nii.gz
4647
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-2_AROMAnoiseICs.csv
47-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-2_desc-confounds_regressors.json
48-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-2_desc-confounds_regressors.tsv
48+
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-2_desc-confounds_timeseries.json
49+
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-2_desc-confounds_timeseries.tsv
4950
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-2_desc-MELODIC_mixing.tsv
5051
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-2_from-scanner_to-T1w_mode-image_xfm.txt
5152
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-2_from-T1w_to-scanner_mode-image_xfm.txt

.circleci/ds005_outputs.txt

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
fmriprep
2+
fmriprep/.bidsignore
23
fmriprep/dataset_description.json
34
fmriprep/desc-aparcaseg_dseg.tsv
45
fmriprep/desc-aseg_dseg.tsv
@@ -51,8 +52,8 @@ fmriprep/sub-01/anat/sub-01_space-MNI152NLin6Asym_label-GM_probseg.nii.gz
5152
fmriprep/sub-01/anat/sub-01_space-MNI152NLin6Asym_label-WM_probseg.nii.gz
5253
fmriprep/sub-01/func
5354
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-1_AROMAnoiseICs.csv
54-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-1_desc-confounds_regressors.json
55-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-1_desc-confounds_regressors.tsv
55+
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-1_desc-confounds_timeseries.json
56+
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-1_desc-confounds_timeseries.tsv
5657
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-1_desc-MELODIC_mixing.tsv
5758
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-1_from-scanner_to-T1w_mode-image_xfm.txt
5859
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-1_from-T1w_to-scanner_mode-image_xfm.txt
@@ -85,8 +86,8 @@ fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-1_space-T1w_desc-brain_mas
8586
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-1_space-T1w_desc-preproc_bold.json
8687
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-1_space-T1w_desc-preproc_bold.nii.gz
8788
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-2_AROMAnoiseICs.csv
88-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-2_desc-confounds_regressors.json
89-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-2_desc-confounds_regressors.tsv
89+
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-2_desc-confounds_timeseries.json
90+
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-2_desc-confounds_timeseries.tsv
9091
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-2_desc-MELODIC_mixing.tsv
9192
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-2_from-scanner_to-T1w_mode-image_xfm.txt
9293
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-2_from-T1w_to-scanner_mode-image_xfm.txt

.circleci/ds005_partial_fasttrack_outputs.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
fmriprep
2+
fmriprep/.bidsignore
23
fmriprep/dataset_description.json
34
fmriprep/desc-aparcaseg_dseg.tsv
45
fmriprep/desc-aseg_dseg.tsv
@@ -10,8 +11,8 @@ fmriprep/logs/CITATION.tex
1011
fmriprep/sub-01
1112
fmriprep/sub-01/func
1213
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-2_AROMAnoiseICs.csv
13-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-2_desc-confounds_regressors.json
14-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-2_desc-confounds_regressors.tsv
14+
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-2_desc-confounds_timeseries.json
15+
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-2_desc-confounds_timeseries.tsv
1516
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-2_desc-MELODIC_mixing.tsv
1617
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-2_from-scanner_to-T1w_mode-image_xfm.txt
1718
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-2_from-T1w_to-scanner_mode-image_xfm.txt

.circleci/ds005_partial_outputs.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
fmriprep
2+
fmriprep/.bidsignore
23
fmriprep/dataset_description.json
34
fmriprep/desc-aparcaseg_dseg.tsv
45
fmriprep/desc-aseg_dseg.tsv
@@ -51,8 +52,8 @@ fmriprep/sub-01/anat/sub-01_space-MNI152NLin6Asym_label-GM_probseg.nii.gz
5152
fmriprep/sub-01/anat/sub-01_space-MNI152NLin6Asym_label-WM_probseg.nii.gz
5253
fmriprep/sub-01/func
5354
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-02_AROMAnoiseICs.csv
54-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-02_desc-confounds_regressors.json
55-
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-02_desc-confounds_regressors.tsv
55+
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-02_desc-confounds_timeseries.json
56+
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-02_desc-confounds_timeseries.tsv
5657
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-02_desc-MELODIC_mixing.tsv
5758
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-02_from-scanner_to-T1w_mode-image_xfm.txt
5859
fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-02_from-T1w_to-scanner_mode-image_xfm.txt

.circleci/ds054_fasttrack_outputs.txt

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
fmriprep
2+
fmriprep/.bidsignore
23
fmriprep/dataset_description.json
34
fmriprep/logs
45
fmriprep/logs/CITATION.bib
@@ -10,8 +11,8 @@ fmriprep/sub-100185/func
1011
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-1_boldref.nii.gz
1112
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-1_desc-brain_mask.json
1213
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-1_desc-brain_mask.nii.gz
13-
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-1_desc-confounds_regressors.json
14-
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-1_desc-confounds_regressors.tsv
14+
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-1_desc-confounds_timeseries.json
15+
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-1_desc-confounds_timeseries.tsv
1516
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-1_desc-preproc_bold.json
1617
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-1_desc-preproc_bold.nii.gz
1718
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-1_from-scanner_to-T1w_mode-image_xfm.txt
@@ -29,8 +30,8 @@ fmriprep/sub-100185/func/sub-100185_task-machinegame_run-1_space-T1w_desc-prepro
2930
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-2_boldref.nii.gz
3031
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-2_desc-brain_mask.json
3132
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-2_desc-brain_mask.nii.gz
32-
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-2_desc-confounds_regressors.json
33-
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-2_desc-confounds_regressors.tsv
33+
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-2_desc-confounds_timeseries.json
34+
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-2_desc-confounds_timeseries.tsv
3435
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-2_desc-preproc_bold.json
3536
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-2_desc-preproc_bold.nii.gz
3637
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-2_from-scanner_to-T1w_mode-image_xfm.txt

.circleci/ds054_outputs.txt

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
fmriprep
2+
fmriprep/.bidsignore
23
fmriprep/dataset_description.json
34
fmriprep/logs
45
fmriprep/logs/CITATION.bib
@@ -29,8 +30,8 @@ fmriprep/sub-100185/func
2930
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-1_boldref.nii.gz
3031
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-1_desc-brain_mask.json
3132
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-1_desc-brain_mask.nii.gz
32-
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-1_desc-confounds_regressors.json
33-
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-1_desc-confounds_regressors.tsv
33+
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-1_desc-confounds_timeseries.json
34+
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-1_desc-confounds_timeseries.tsv
3435
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-1_desc-preproc_bold.json
3536
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-1_desc-preproc_bold.nii.gz
3637
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-1_from-scanner_to-T1w_mode-image_xfm.txt
@@ -48,8 +49,8 @@ fmriprep/sub-100185/func/sub-100185_task-machinegame_run-1_space-T1w_desc-prepro
4849
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-2_boldref.nii.gz
4950
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-2_desc-brain_mask.json
5051
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-2_desc-brain_mask.nii.gz
51-
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-2_desc-confounds_regressors.json
52-
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-2_desc-confounds_regressors.tsv
52+
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-2_desc-confounds_timeseries.json
53+
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-2_desc-confounds_timeseries.tsv
5354
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-2_desc-preproc_bold.json
5455
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-2_desc-preproc_bold.nii.gz
5556
fmriprep/sub-100185/func/sub-100185_task-machinegame_run-2_from-scanner_to-T1w_mode-image_xfm.txt

.circleci/ds210_fasttrack_outputs.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
fmriprep
2+
fmriprep/.bidsignore
23
fmriprep/dataset_description.json
34
fmriprep/logs
45
fmriprep/logs/CITATION.bib
@@ -7,8 +8,8 @@ fmriprep/logs/CITATION.md
78
fmriprep/logs/CITATION.tex
89
fmriprep/sub-02
910
fmriprep/sub-02/func
10-
fmriprep/sub-02/func/sub-02_task-cuedSGT_run-1_desc-confounds_regressors.json
11-
fmriprep/sub-02/func/sub-02_task-cuedSGT_run-1_desc-confounds_regressors.tsv
11+
fmriprep/sub-02/func/sub-02_task-cuedSGT_run-1_desc-confounds_timeseries.json
12+
fmriprep/sub-02/func/sub-02_task-cuedSGT_run-1_desc-confounds_timeseries.tsv
1213
fmriprep/sub-02/func/sub-02_task-cuedSGT_run-1_from-scanner_to-T1w_mode-image_xfm.txt
1314
fmriprep/sub-02/func/sub-02_task-cuedSGT_run-1_from-T1w_to-scanner_mode-image_xfm.txt
1415
fmriprep/sub-02/func/sub-02_task-cuedSGT_run-1_space-MNI152NLin2009cAsym_boldref.nii.gz

.circleci/ds210_outputs.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
fmriprep
2+
fmriprep/.bidsignore
23
fmriprep/dataset_description.json
34
fmriprep/logs
45
fmriprep/logs/CITATION.bib
@@ -26,8 +27,8 @@ fmriprep/sub-02/anat/sub-02_space-MNI152NLin2009cAsym_label-CSF_probseg.nii.gz
2627
fmriprep/sub-02/anat/sub-02_space-MNI152NLin2009cAsym_label-GM_probseg.nii.gz
2728
fmriprep/sub-02/anat/sub-02_space-MNI152NLin2009cAsym_label-WM_probseg.nii.gz
2829
fmriprep/sub-02/func
29-
fmriprep/sub-02/func/sub-02_task-cuedSGT_run-1_desc-confounds_regressors.json
30-
fmriprep/sub-02/func/sub-02_task-cuedSGT_run-1_desc-confounds_regressors.tsv
30+
fmriprep/sub-02/func/sub-02_task-cuedSGT_run-1_desc-confounds_timeseries.json
31+
fmriprep/sub-02/func/sub-02_task-cuedSGT_run-1_desc-confounds_timeseries.tsv
3132
fmriprep/sub-02/func/sub-02_task-cuedSGT_run-1_from-scanner_to-T1w_mode-image_xfm.txt
3233
fmriprep/sub-02/func/sub-02_task-cuedSGT_run-1_from-T1w_to-scanner_mode-image_xfm.txt
3334
fmriprep/sub-02/func/sub-02_task-cuedSGT_run-1_space-MNI152NLin2009cAsym_boldref.nii.gz

docs/links.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
.. _Nipype: http://nipype.readthedocs.io/en/latest/
22
.. _BIDS: http://bids.neuroimaging.io
3-
.. _`BIDS Derivatives`: https://docs.google.com/document/d/17ebopupQxuRwp7U7TFvS6BH03ALJOgGHufxK8ToAvyI
4-
.. _`BIDS Derivatives RC1`: https://docs.google.com/document/d/17ebopupQxuRwp7U7TFvS6BH03ALJOgGHufxK8ToAvyI
3+
.. _`BIDS Derivatives`: https://bids-specification.readthedocs.io/en/stable/05-derivatives/01-introduction.html
4+
.. _`BEP 011`: https://bids-specification.readthedocs.io/en/bep011/05-derivatives/04-structural-derivatives.html
5+
.. _`BEP 012`: https://bids-specification.readthedocs.io/en/bep012/05-derivatives/05-functional-derivatives.html
56
.. _Installation: installation.html
67
.. _workflows: workflows.html
78
.. _FSL: https://fsl.fmrib.ox.ac.uk/fsl/fslwiki/

docs/outputs.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66
Outputs of *fMRIPrep*
77
---------------------
88
*fMRIPrep* outputs conform to the :abbr:`BIDS (brain imaging data structure)`
9-
Derivatives specification (see `BIDS Derivatives RC1`_).
9+
Derivatives specification (see `BIDS Derivatives`_, along with the
10+
upcoming `BEP 011`_ and `BEP 012`_).
1011
*fMRIPrep* generates three broad classes of outcomes:
1112

1213
1. **Visual QA (quality assessment) reports**:
@@ -46,7 +47,7 @@ Derivatives of *fMRIPrep* (preprocessed data)
4647
---------------------------------------------
4748
Preprocessed, or derivative, data are written to
4849
``<output dir>/fmriprep/sub-<subject_label>/``.
49-
The `BIDS Derivatives RC1`_ specification describes the naming and metadata conventions we follow.
50+
The `BIDS Derivatives`_ specification describes the naming and metadata conventions we follow.
5051

5152
Anatomical derivatives
5253
~~~~~~~~~~~~~~~~~~~~~~
@@ -146,7 +147,7 @@ mid-thickness surface mesh::
146147
func/
147148
sub-<subject_label>_[specifiers]_space-T1w_desc-aparcaseg_dseg.nii.gz
148149
sub-<subject_label>_[specifiers]_space-T1w_desc-aseg_dseg.nii.gz
149-
sub-<subject_label>_[specifiers]_space-<space_label>_hemi-[LR].func.gii
150+
sub-<subject_label>_[specifiers]_space-<space_label>_hemi-[LR]_bold.func.gii
150151

151152
Surface output spaces include ``fsnative`` (full density subject-specific mesh),
152153
``fsaverage`` and the down-sampled meshes ``fsaverage6`` (41k vertices) and
@@ -177,8 +178,8 @@ Confounds_ are saved as a :abbr:`TSV (tab-separated value)` file::
177178

178179
sub-<subject_label>/
179180
func/
180-
sub-<subject_label>_[specifiers]_desc-confounds_regressors.tsv
181-
sub-<subject_label>_[specifiers]_desc-confounds_regressors.json
181+
sub-<subject_label>_[specifiers]_desc-confounds_timeseries.tsv
182+
sub-<subject_label>_[specifiers]_desc-confounds_timeseries.json
182183

183184
These :abbr:`TSV (tab-separated values)` tables look like the example below,
184185
where each row of the file corresponds to one time point found in the
@@ -233,7 +234,7 @@ session and run in :abbr:`TSV (tab-separated value)` files - one column for each
233234
Such tabular files may include over 100 columns of potential confound regressors.
234235

235236
.. danger::
236-
Do not include all columns of ``~_desc-confounds_regressors.tsv`` table
237+
Do not include all columns of ``~_desc-confounds_timeseries.tsv`` table
237238
into your design matrix or denoising procedure.
238239
Filter the table first, to include only the confounds (or components thereof)
239240
you want to remove from your fMRI signal.
@@ -386,7 +387,7 @@ For CompCor decompositions, entries include:
386387
- ``VarianceExplained``: the fraction of variance explained by the component across the decomposition ROI mask.
387388
- ``CumulativeVarianceExplained``: the total fraction of variance explained by this particular component
388389
and all preceding components.
389-
- ``Retained``: Indicates whether the component was saved in ``desc-confounds_regressors.tsv``
390+
- ``Retained``: Indicates whether the component was saved in ``desc-confounds_timeseries.tsv``
390391
for use in denoising.
391392
Entries that are not saved in the data file for denoising are still stored in metadata with the
392393
``dropped`` prefix.

0 commit comments

Comments
 (0)