Skip to content

Commit 4a01d9b

Browse files
Add another example to inheritance principle for .json without entities (#2019)
Upon re-reading current Inheritance principle formulation, nothing seems to forbid that, and such use in general is great since allows to generalize common metadata across all files of that datatype. Notes on possible side-effects from "embracing" such approach (which in principle I think is not disallowed ATM). - per rule 4, presence of `bold.json` forbids presence of another `_bold.json` (i.e with entity) on the same level. So if further specialization e.g. per each task- is needed, common metadata needs to be duplicated across them (that is what heudiconv does ATM). Such restrictions could potentially be elevated if we adopt "summarization" refactoring of inheritance principle bids-standard/bids-2-devel#65 since order would stop to matter and thus multiple files can apply. - I think that bids-validators are fine as checked on a single ds000248/T1w.json in bids-examples and modified 7t_trt. - I do not know if tools implement it though but since there was precedence for ds000248/T1w.json - they better do ;-) Co-authored-by: Julia-Katharina Pfarr <111446107+julia-pfarr@users.noreply.github.com>
1 parent 557ca40 commit 4a01d9b

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

src/common-principles.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -909,6 +909,28 @@ A guide for using macros can be found at
909909
}
910910
) }}
911911

912+
Example 5: Generalization of Examples 1 and 4 for a sidecar file without entities
913+
914+
<!-- This block generates a file tree.
915+
A guide for using macros can be found at
916+
https://github.com/bids-standard/bids-specification/blob/master/macros_doc.md
917+
-->
918+
{{ MACROS___make_filetree_example(
919+
{
920+
"sub-01": {
921+
"anat": {},
922+
"func": {
923+
"sub-01_task-xyz_acq-test1_run-1_bold.nii.gz": "",
924+
"sub-01_task-xyz_acq-test1_run-2_bold.nii.gz": "",
925+
}
926+
},
927+
"bold.json": "",
928+
}
929+
) }}
930+
931+
where `bold.json` in top directory would be applicable to all `_bold.nii.gz`
932+
regardless of any other entity in their filename.
933+
912934
## Participant names and other labels
913935

914936
BIDS allows for custom user-defined `<label>`s and `<index>`es for example,

0 commit comments

Comments
 (0)