Skip to content

Commit cdca116

Browse files
markmikkelsenmarkmikkelsen
authored
Merge branch 'bids-standard:master' into dev
2 parents 0b45139 + dbe1cd0 commit cdca116

File tree

5 files changed

+83
-58
lines changed

5 files changed

+83
-58
lines changed

‎Maintainers_Guide.md‎

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,20 @@ which is a recommended reading in conjunction with this guide.
1313

1414
See also: [BIDS governance](https://bids.neuroimaging.io/collaboration/governance.html#bids-maintainers-group)
1515

16-
| Name | Time commitment | Scope | Joined |
17-
| ------------------------------------------------------------------------- | --------------- | ------------------------------------- | -------- |
18-
| Stefan Appelhoff ([@sappelhoff](https://github.com/sappelhoff)) | 1h/week | | Mar 2020 |
19-
| Chris Markiewicz ([@effigies](https://github.com/effigies)) | 5h/week | | Mar 2020 |
20-
| Ross Blair ([@rwblair](https://github.com/rwblair)) | | Maintainer of the bids-validator | Mar 2020 |
21-
| Taylor Salo ([@tsalo](https://github.com/tsalo)) | 3h/week | MRI | Sep 2020 |
22-
| Remi Gau ([@Remi-Gau](https://github.com/Remi-Gau)) | 3h/week | Community development, MRI | Oct 2020 |
23-
| Anthony Galassi ([@bendhouseart](https://github.com/bendhouseart)) | 3h/week | PET, Community development | Sep 2021 |
24-
| Eric Earl ([@ericearl](https://github.com/ericearl)) | 2h/week | | Dec 2021 |
25-
| Christine Rogers ([@christinerogers](https://github.com/christinerogers)) | 2h/month | Interoperability, EEG and multi-modal | Apr 2023 |
26-
| Nell Hardcastle ([@nellh](https://github.com/nellh)) | 2h/week | | Jul 2023 |
27-
| Kimberly Ray ([@KimberlyLRay](https://github.com/KimberlyLRay)) | 1h/week | | Nov 2022 |
28-
| Julia-Katharina Pfarr ([@julia-pfarr](https://github.com/julia-pfarr)) | 2h/week | | Mar 2025 |
16+
| Name | Time commitment | Scope | Joined |
17+
| ---------------------------------------------------------------------------- | --------------- | ------------------------------------- | -------- |
18+
| Stefan Appelhoff ([@sappelhoff](https://github.com/sappelhoff)) | 1h/week | | Mar 2020 |
19+
| Chris Markiewicz ([@effigies](https://github.com/effigies)) | 5h/week | | Mar 2020 |
20+
| Ross Blair ([@rwblair](https://github.com/rwblair)) | | Maintainer of the bids-validator | Mar 2020 |
21+
| Taylor Salo ([@tsalo](https://github.com/tsalo)) | 3h/week | MRI | Sep 2020 |
22+
| Remi Gau ([@Remi-Gau](https://github.com/Remi-Gau)) | 3h/week | Community development, MRI | Oct 2020 |
23+
| Anthony Galassi ([@bendhouseart](https://github.com/bendhouseart)) | 3h/week | PET, Community development | Sep 2021 |
24+
| Eric Earl ([@ericearl](https://github.com/ericearl)) | 2h/week | | Dec 2021 |
25+
| Christine Rogers ([@christinerogers](https://github.com/christinerogers)) | 2h/month | Interoperability, EEG and multi-modal | Apr 2023 |
26+
| Nell Hardcastle ([@nellh](https://github.com/nellh)) | 2h/week | | Jul 2023 |
27+
| Kimberly Ray ([@KimberlyLRay](https://github.com/KimberlyLRay)) | 1h/week | | Nov 2022 |
28+
| Julia-Katharina Pfarr ([@julia-pfarr](https://github.com/julia-pfarr)) | 2h/week | | Mar 2025 |
29+
| Seyed (Yahya) Shirazi ([@neuromechanist](https://github.com/neuromechanist)) | 2h/week | ExG, multi-modal, events & annotations | Jul 2025 |
2930

3031
In addition to the [BIDS Governance](https://bids.neuroimaging.io/collaboration/governance.html#bids-maintainers-group)
3132
classification of a maintainer, maintainers may declare a limited scope of responsibility.

‎src/common-principles.md‎

Lines changed: 47 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -275,49 +275,6 @@ However, in the case that these data are to be included:
275275
We RECOMMEND including the PDF print-out with the actual sequence
276276
parameters generated by the scanner in the `sourcedata` directory.
277277

278-
Alternatively one can organize their data in the following way
279-
280-
<!-- This block generates a file tree.
281-
A guide for using macros can be found at
282-
https://github.com/bids-standard/bids-specification/blob/master/macros_doc.md
283-
-->
284-
{{ MACROS___make_filetree_example(
285-
{
286-
"my_project-1": {
287-
"sourcedata": {
288-
"dicoms": {},
289-
"raw": {
290-
"sub-01": {},
291-
"sub-02": {},
292-
"...": "",
293-
"dataset_description.json": "",
294-
"...": "",
295-
},
296-
"..." : "",
297-
},
298-
"derivatives": {
299-
"pipeline_1": {},
300-
"pipeline_2": {},
301-
"...": "",
302-
}
303-
}
304-
}
305-
) }}
306-
307-
In this example, `sourcedata/dicoms` is not nested inside
308-
`sourcedata/raw`, **and only the `sourcedata/raw` subdirectory** is a BIDS-compliant dataset among `sourcedata/` subfolders.
309-
The subdirectories of `derivatives` MAY be BIDS-compliant derivatives datasets
310-
(see [Non-compliant derivatives](#non-compliant-derivatives) for further discussion).
311-
The above example is just a convention useful for organizing source, raw BIDS, and derived BIDS data while maintaining BIDS compliance of the raw data directory.
312-
When using this convention it is RECOMMENDED to set the `SourceDatasets`
313-
field in `dataset_description.json` of each subdirectory of `derivatives` to:
314-
315-
```JSON
316-
{
317-
"SourceDatasets": [ {"URL": "../../sourcedata/raw/"} ]
318-
}
319-
```
320-
321278
!!! danger "Caution"
322279

323280
Sharing source data may help amend errors and missing data discovered
@@ -443,6 +400,53 @@ In particular, if a BIDS dataset contains a `derivatives/` subdirectory,
443400
the contents of that directory may be a heterogeneous mix of BIDS Derivatives
444401
datasets and non-compliant derivatives.
445402
403+
## Study dataset
404+
405+
BIDS allows one to organize the data for the entire study (original source data, raw BIDS, derivatives) as a valid BIDS dataset in the following way
406+
407+
<!-- This block generates a file tree.
408+
A guide for using macros can be found at
409+
https://github.com/bids-standard/bids-specification/blob/master/macros_doc.md
410+
-->
411+
{{ MACROS___make_filetree_example(
412+
{
413+
"study-1": {
414+
"sourcedata": {
415+
"dicoms": {},
416+
"raw": {
417+
"sub-01": {},
418+
"sub-02": {},
419+
"...": "",
420+
"dataset_description.json": "",
421+
"...": "",
422+
},
423+
"..." : "",
424+
},
425+
"derivatives": {
426+
"pipeline_1": {},
427+
"pipeline_2": {},
428+
"...": "",
429+
},
430+
"dataset_description.json": "",
431+
"...": "",
432+
}
433+
}
434+
) }}
435+
436+
In this example, `sourcedata/dicoms` is not nested inside
437+
`sourcedata/raw`, **and only the `sourcedata/raw` subdirectory** is a BIDS-compliant dataset among `sourcedata/` subfolders.
438+
The subdirectories of `derivatives` MAY be BIDS-compliant derivatives datasets
439+
(see [Non-compliant derivatives](#non-compliant-derivatives) for further discussion).
440+
The above example is a fully compliant BIDS dataset, providing a convention useful for organizing source, raw BIDS, and derived BIDS data while maintaining overall BIDS compliance.
441+
When using this convention, `dataset_description.json` MUST have `DatasetType` to be set to `"study"`. It is also RECOMMENDED to set the `SourceDatasets`
442+
field in `dataset_description.json` of each subdirectory of `derivatives` to:
443+
444+
```JSON
445+
{
446+
"SourceDatasets": [ {"URL": "../../sourcedata/raw/"} ]
447+
}
448+
```
449+
446450
## File format specification
447451

448452
### Imaging files

‎src/schema/objects/enums.yaml‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -360,14 +360,20 @@ individual:
360360
In context of surfaces this space has been referred to as `fsnative`.
361361
362362
In order for this space to be interpretable, `SpatialReference` metadata MUST be provided.
363-
study:
363+
study__space:
364364
value: study
365365
display_name: study
366366
description: |
367367
Custom space defined using a group/study-specific template.
368368
This coordinate system requires specifying an additional file to be fully defined.
369369
370370
In order for this space to be interpretable, `SpatialReference` metadata MUST be provided.
371+
study__datasettype:
372+
value: study
373+
display_name: study
374+
description: |
375+
A study BIDS dataset to organize the data for the entire study (original source data, raw BIDS,
376+
derivatives) as a valid BIDS dataset.
371377
scanner:
372378
value: scanner
373379
display_name: scanner

‎src/schema/objects/metadata.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -582,6 +582,7 @@ DatasetType:
582582
enum:
583583
- $ref: objects.enums.raw.value
584584
- $ref: objects.enums.derivative.value
585+
- $ref: objects.enums.study__datasettype.value
585586
DecayCorrectionFactor:
586587
name: DecayCorrectionFactor
587588
display_name: Decay Correction Factor

‎src/schema/rules/checks/dataset.yaml‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,26 @@ SubjectFolders:
66
issue:
77
code: SUBJECT_FOLDERS
88
message: |
9-
There are no subject directories (labeled "sub-*") in the root of this dataset.
9+
There are no subject directories (labeled "sub-*") in the root of this BIDS dataset.
1010
level: warning
1111
selectors:
1212
- path == '/dataset_description.json'
13+
- dataset.dataset_description.DatasetType != "study"
1314
checks:
1415
- length(dataset.subjects.sub_dirs) > 0
1516

17+
NoSubjectFolders:
18+
issue:
19+
code: NOSUBJECT_FOLDERS
20+
message: |
21+
There should be no subject directories (labeled "sub-*") in the root of this study BIDS dataset.
22+
level: warning
23+
selectors:
24+
- path == '/dataset_description.json'
25+
- dataset.dataset_description.DatasetType == "study"
26+
checks:
27+
- length(dataset.subjects.sub_dirs) == 0
28+
1629
# 49
1730
ParticipantIDMismatch:
1831
issue:

0 commit comments

Comments
 (0)