feat(schema): Expand use of raw templates

Author: effigies

src/schema/meta/templates.yaml

@@ -17,6 +17,30 @@ raw:
       subject: required
       session: optional
 
+  recording:
+    entities:
+      $ref: meta.templates.raw.base.entities
+      acquisition: optional
+      run: optional
+
+  task:
+    entities:
+      $ref: meta.templates.raw.recording.entities
+      task: required
+
+  mri:
+    entities:
+      $ref: meta.templates.raw.recording.entities
+      ceagent: optional
+      reconstruction: optional
+      chunk: optional
+
+  epi:
+    entities:
+      $ref: meta.templates.raw.mri.entities
+      direction: optional
+      part: optional
+
 # Entities that apply to most derivative files
 # Include thus:
 #

src/schema/rules/files/raw/anat.yaml

@@ -20,15 +20,10 @@ nonparametric:
   datatypes:
     - anat
   entities:
-    $ref: meta.templates.raw.base.entities
+    $ref: meta.templates.raw.mri.entities
     task: optional
-    acquisition: optional
-    ceagent: optional
-    reconstruction: optional
-    run: optional
     echo: optional
     part: optional
-    chunk: optional
 
 parametric:
   suffixes:
@@ -55,13 +50,8 @@ parametric:
   datatypes:
     - anat
   entities:
-    $ref: meta.templates.raw.base.entities
+    $ref: meta.templates.raw.mri.entities
     task: optional
-    acquisition: optional
-    ceagent: optional
-    reconstruction: optional
-    run: optional
-    chunk: optional
 
 defacemask:
   suffixes:
@@ -73,14 +63,9 @@ defacemask:
   datatypes:
     - anat
   entities:
-    $ref: meta.templates.raw.base.entities
+    $ref: meta.templates.raw.mri.entities
     task: optional
-    acquisition: optional
-    ceagent: optional
-    reconstruction: optional
-    run: optional
     modality: optional
-    chunk: optional
 
 megre:
   suffixes:
@@ -92,15 +77,10 @@ megre:
   datatypes:
     - anat
   entities:
-    $ref: meta.templates.raw.base.entities
+    $ref: meta.templates.raw.mri.entities
     task: optional
-    acquisition: optional
-    ceagent: optional
-    reconstruction: optional
-    run: optional
     echo: required
     part: optional
-    chunk: optional
 
 mese:
   suffixes:
@@ -112,16 +92,11 @@ mese:
   datatypes:
     - anat
   entities:
-    $ref: meta.templates.raw.base.entities
+    $ref: meta.templates.raw.mri.entities
     task: optional
-    acquisition: optional
-    ceagent: optional
-    reconstruction: optional
     direction: optional
-    run: optional
     echo: required
     part: optional
-    chunk: optional
 
 multiflip:
   suffixes:
@@ -133,16 +108,11 @@ multiflip:
   datatypes:
     - anat
   entities:
-    $ref: meta.templates.raw.base.entities
+    $ref: meta.templates.raw.mri.entities
     task: optional
-    acquisition: optional
-    ceagent: optional
-    reconstruction: optional
-    run: optional
     echo: optional
     flip: required
     part: optional
-    chunk: optional
 
 multiinversion:
   suffixes:
@@ -154,15 +124,10 @@ multiinversion:
   datatypes:
     - anat
   entities:
-    $ref: meta.templates.raw.base.entities
+    $ref: meta.templates.raw.mri.entities
     task: optional
-    acquisition: optional
-    ceagent: optional
-    reconstruction: optional
-    run: optional
     inversion: required
     part: optional
-    chunk: optional
 
 mp2rage:
   suffixes:
@@ -174,17 +139,12 @@ mp2rage:
   datatypes:
     - anat
   entities:
-    $ref: meta.templates.raw.base.entities
+    $ref: meta.templates.raw.mri.entities
     task: optional
-    acquisition: optional
-    ceagent: optional
-    reconstruction: optional
-    run: optional
     echo: optional
     flip: optional
     inversion: required
     part: optional
-    chunk: optional
 
 vfamt:
   suffixes:
@@ -197,17 +157,12 @@ vfamt:
   datatypes:
     - anat
   entities:
-    $ref: meta.templates.raw.base.entities
+    $ref: meta.templates.raw.mri.entities
     task: optional
-    acquisition: optional
-    ceagent: optional
-    reconstruction: optional
-    run: optional
     echo: optional
     flip: required
     mtransfer: required
     part: optional
-    chunk: optional
 
 mtr:
   suffixes:
@@ -219,12 +174,7 @@ mtr:
   datatypes:
     - anat
   entities:
-    $ref: meta.templates.raw.base.entities
+    $ref: meta.templates.raw.mri.entities
     task: optional
-    acquisition: optional
-    ceagent: optional
-    reconstruction: optional
-    run: optional
     mtransfer: required
     part: optional
-    chunk: optional

src/schema/rules/files/raw/beh.yaml

@@ -1,15 +1,11 @@
 ---
 # Non-continuous data
 noncontinuous:
+  $ref: meta.templates.raw.task
   suffixes:
     - beh
   extensions:
     - .tsv
     - .json
   datatypes:
     - beh
-  entities:
-    $ref: meta.templates.raw.base.entities
-    task: required
-    acquisition: optional
-    run: optional

src/schema/rules/files/raw/channels.yaml

@@ -1,5 +1,6 @@
 ---
 channels:
+  $ref: meta.templates.raw.task
   suffixes:
     - channels
   extensions:
@@ -9,11 +10,6 @@ channels:
     - eeg
     - ieeg
     - nirs
-  entities:
-    $ref: meta.templates.raw.base.entities
-    task: required
-    acquisition: optional
-    run: optional
 
 # MEG has an additional entity available
 channels__meg:
@@ -66,10 +62,8 @@ electrodes:
     - eeg
     - ieeg
   entities:
-    $ref: meta.templates.raw.base.entities
+    $ref: meta.templates.raw.recording.entities
     task: optional
-    acquisition: optional
-    run: optional
     space: optional
 
 # MEG has an additional entity available

src/schema/rules/files/raw/dwi.yaml

@@ -11,13 +11,10 @@ dwi:
   datatypes:
     - dwi
   entities:
-    $ref: meta.templates.raw.base.entities
-    acquisition: optional
-    reconstruction: optional
-    direction: optional
-    run: optional
-    part: optional
-    chunk: optional
+    $ref: meta.templates.raw.epi.entities
+    # Historically BIDS has not permitted ceagent for DWI
+    # This could be relaxed without backwards incompatibility
+    ceagent: null
 
 sbref:
   suffixes:
@@ -29,13 +26,8 @@ sbref:
   datatypes:
     - dwi
   entities:
-    $ref: meta.templates.raw.base.entities
-    acquisition: optional
-    reconstruction: optional
-    direction: optional
-    run: optional
-    part: optional
-    chunk: optional
+    $ref: meta.templates.raw.epi.entities
+    ceagent: null
 
 # Common scanner-generated derivatives need raw names
 ScannerDerivatives:
@@ -53,10 +45,7 @@ ScannerDerivatives:
   datatypes:
     - dwi
   entities:
-    subject: required
-    session: optional
-    acquisition: optional
-    reconstruction: optional
-    direction: optional
-    run: optional
-    chunk: optional
+    $ref: meta.templates.raw.epi.entities
+    # part is also not defined for derivative maps
+    ceagent: null
+    part: null

src/schema/rules/files/raw/eeg.yaml

@@ -1,5 +1,6 @@
 ---
 eeg:
+  $ref: meta.templates.raw.task
   suffixes:
     - eeg
   extensions:
@@ -13,8 +14,3 @@ eeg:
     - .bdf
   datatypes:
     - eeg
-  entities:
-    $ref: meta.templates.raw.base.entities
-    task: required
-    acquisition: optional
-    run: optional

src/schema/rules/files/raw/events.yaml

@@ -1,5 +1,6 @@
 ---
 events:
+  $ref: meta.templates.raw.task
   suffixes:
     - events
   extensions:
@@ -11,11 +12,6 @@ events:
     - ieeg
     - meg
     - nirs
-  entities:
-    $ref: meta.templates.raw.base.entities
-    task: required
-    acquisition: optional
-    run: optional
 
 # Specializations
 # In these rules, we use $ref to retrieve most of an object, and then override
@@ -43,12 +39,11 @@ events__pet:
   datatypes:
     - pet
   entities:
-    # Most events allow acquisition, PET doesn't
-    $ref: meta.templates.raw.base.entities
-    task: required
+    $ref: meta.templates.raw.task.entities
     tracer: optional
     reconstruction: optional
-    run: optional
+    # Most events allow acquisition, PET doesn't
+    acquisition: null
 
 events__mrs:
   $ref: rules.files.raw.events.events