Skip to content

Commit 54f6281

Browse files
authored
Merge pull request #334 from effigies/fix/relaxation
ENH: Clarify the position toward non-compliant derivative datasets and files
2 parents 70dc262 + 2c5db7c commit 54f6281

File tree

2 files changed

+25
-5
lines changed

2 files changed

+25
-5
lines changed

src/02-common-principles.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,8 @@ However, in the case that these data are to be included:
123123
`sourcedata/sub-01/ses-pre/func/sub-01_ses-pre_task-rest_bold.dicom.tgz` or
124124
`sourcedata/sub-01/ses-pre/func/MyEvent.sce`.
125125

126-
1. A README file SHOULD be found at the root of the `sourcedata` folder.
126+
1. A README file SHOULD be found at the root of the `sourcedata` folder or the
127+
`derivatives` folder, or both.
127128
This file should describe the nature of the raw data or the derived data.
128129
We RECOMMEND including the PDF print-out with the actual sequence
129130
parameters generated by the scanner in the `sourcedata` folder.
@@ -146,10 +147,14 @@ my_dataset/
146147
...
147148
```
148149

149-
In this example **only the `rawdata` subfolder and all subfolders of `derivatives`
150-
need to be BIDS compliant** datasets. This specification does not prescribe
151-
anything about the contents of `sourcedata` folders in the above example - nor
152-
does it prescribe the `sourcedata`, `derivatives`, or `rawdata` folder names.
150+
In this example, where `sourcedata` and `derivatives` are not nested inside
151+
`rawdata`, **only the `rawdata` subfolder** needs to be a BIDS-compliant
152+
dataset.
153+
The subfolders of `derivatives` MAY be BIDS-compliant derivatives datasets
154+
(see [Non-compliant datasets][non-compliant-datasets] for further discussion).
155+
This specification does not prescribe anything about the contents of `sourcedata`
156+
folders in the above example - nor does it prescribe the `sourcedata`,
157+
`derivatives`, or `rawdata` folder names.
153158
The above example is just a convention that can be useful for organizing raw,
154159
source, and derived data while maintaining BIDS compliancy of the raw data
155160
folder. When using this convention it is RECOMMENDED to set the `SourceDatasets`
@@ -450,3 +455,5 @@ special cases. They should be named using all lowercase with a name that
450455
reflects the nature of the scan (e.g., `calibration`). Naming of files within
451456
the directory should follow the same scheme as above (e.g.,
452457
`sub-control01_calibration_Xcalibration.nii.gz`)
458+
459+
[non-compliant-datasets]: 05-derivatives/01-introduction.md#non-compliant-datasets

src/05-derivatives/01-introduction.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -222,3 +222,16 @@ sub-01/anat/sub-01_hemi-L_space-individual_thickness.json
222222
distinguish brain mask files derived from T1w and T2w images; or `_desc-sm4`
223223
and `_desc-sm8` to distinguish between outputs generated with two different
224224
levels of smoothing).
225+
226+
- When naming files that are not yet standardized, it is RECOMMENDED to use
227+
names consistent with BIDS conventions where those conventions apply.
228+
For example, if a summary statistic is derived from a given task, the file
229+
name SHOULD contain `_task-<label>`.
230+
231+
## Non-compliant datasets
232+
233+
Nothing in this specification should be interpreted to disallow the
234+
storage/distribution non-compliant derivatives of BIDS datasets.
235+
In particular, if a BIDS dataset contains a `derivatives/` sub-directory,
236+
the contents of that directory may be a heterogeneous mix of BIDS Derivatives
237+
datasets and non-compliant derivatives.

0 commit comments

Comments
 (0)