Skip to content

Commit 009c8b6

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 f0e14a2 commit 009c8b6

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
@@ -283,7 +283,7 @@ A guide for using macros can be found at
283283
-->
284284
{{ MACROS___make_filetree_example(
285285
{
286-
"my_project-1": {
286+
"my_dataset-1": {
287287
"sourcedata": {
288288
"dicoms": {},
289289
"raw": {
@@ -299,7 +299,9 @@ A guide for using macros can be found at
299299
"pipeline_1": {},
300300
"pipeline_2": {},
301301
"...": "",
302-
}
302+
},
303+
"dataset_description.json": "",
304+
"...": "",
303305
}
304306
}
305307
) }}
@@ -308,7 +310,7 @@ In this example, `sourcedata/dicoms` is not nested inside
308310
`sourcedata/raw`, **and only the `sourcedata/raw` subdirectory** is a BIDS-compliant dataset among `sourcedata/` subfolders.
309311
The subdirectories of `derivatives` MAY be BIDS-compliant derivatives datasets
310312
(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.
313+
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.
312314
When using this convention it is RECOMMENDED to set the `SourceDatasets`
313315
field in `dataset_description.json` of each subdirectory of `derivatives` to:
314316

0 commit comments

Comments
 (0)