Skip to content

Commit

Permalink
Add the notion that example layout can in fact be a valid BIDS dataset
Browse files Browse the repository at this point in the history
This reverts commit a3c12f8 where I have tried
to introduce it in
#1741 but it required a
little more of further detailing.
  • Loading branch information
yarikoptic committed Jun 20, 2024
1 parent 8095453 commit 37c32f5
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions src/common-principles.md
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ A guide for using macros can be found at
-->
{{ MACROS___make_filetree_example(
{
"my_project-1": {
"my_dataset-1": {
"sourcedata": {
"dicoms": {},
"raw": {
Expand All @@ -294,7 +294,9 @@ A guide for using macros can be found at
"pipeline_1": {},
"pipeline_2": {},
"...": "",
}
},
"dataset_description.json": "",
"...": "",
}
}
) }}
Expand All @@ -303,7 +305,7 @@ In this example, `sourcedata/dicoms` is not nested inside
`sourcedata/raw`, **and only the `sourcedata/raw` subdirectory** is a BIDS-compliant dataset among `sourcedata/` subfolders.
The subdirectories of `derivatives` MAY be BIDS-compliant derivatives datasets
(see [Non-compliant derivatives](#non-compliant-derivatives) for further discussion).
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.
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.
When using this convention it is RECOMMENDED to set the `SourceDatasets`
field in `dataset_description.json` of each subdirectory of `derivatives` to:

Expand Down

0 comments on commit 37c32f5

Please sign in to comment.