Skip to content

Commit 37c32f5

Browse files
committed
Add the notion that example layout can in fact be a valid BIDS dataset
This reverts commit a3c12f8 where I have tried to introduce it in #1741 but it required a little more of further detailing.
1 parent 8095453 commit 37c32f5

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

src/common-principles.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ A guide for using macros can be found at
278278
-->
279279
{{ MACROS___make_filetree_example(
280280
{
281-
"my_project-1": {
281+
"my_dataset-1": {
282282
"sourcedata": {
283283
"dicoms": {},
284284
"raw": {
@@ -294,7 +294,9 @@ A guide for using macros can be found at
294294
"pipeline_1": {},
295295
"pipeline_2": {},
296296
"...": "",
297-
}
297+
},
298+
"dataset_description.json": "",
299+
"...": "",
298300
}
299301
}
300302
) }}
@@ -303,7 +305,7 @@ In this example, `sourcedata/dicoms` is not nested inside
303305
`sourcedata/raw`, **and only the `sourcedata/raw` subdirectory** is a BIDS-compliant dataset among `sourcedata/` subfolders.
304306
The subdirectories of `derivatives` MAY be BIDS-compliant derivatives datasets
305307
(see [Non-compliant derivatives](#non-compliant-derivatives) for further discussion).
306-
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.
308+
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.
307309
When using this convention it is RECOMMENDED to set the `SourceDatasets`
308310
field in `dataset_description.json` of each subdirectory of `derivatives` to:
309311

0 commit comments

Comments
 (0)