diff --git a/src/modality-agnostic-files.md b/src/modality-agnostic-files.md index c6890aa6b4..e928abebdb 100644 --- a/src/modality-agnostic-files.md +++ b/src/modality-agnostic-files.md @@ -30,6 +30,7 @@ and a guide for using macros can be found at { "Name": "REQUIRED", "BIDSVersion": "REQUIRED", + "BIDSEntitiesLayout": "REQUIRED if layout is not just sub-*/", "HEDVersion": "RECOMMENDED", "DatasetLinks": "REQUIRED if [BIDS URIs][] are used", "DatasetType": "RECOMMENDED", @@ -103,6 +104,102 @@ Example: } ``` +#### BIDS Entities Layout + +The `BIDSEntitiesLayout` field is REQUIRED if the layout of the dataset is not just `sub-*/` of a typical BIDS 1.0 dataset without sessions. + +The `BIDSEntitiesLayout` field is an object where keys are directory names and values are lists of objects describing order of entities defining hierarchy and/or file name prefixes that are expected to be found in the directory. + +**TODO**: define "Entity" and "Datatype" in glossary. + +**TODO**: check if *concept* is the best term to use here. + +It could be an [entity](appendix/entity-table.md) or the [datatype](glossary.md#datatype) concept to define that level of the hierarchy. + +By default, each level represented both as a directory and a prefix in the file name, e.g. having `subject` entity would establish `sub-