Uncombine required/recommended/optional fields

bids-standard · Jun 1, 2024 · 1d5e089 · 1d5e089
1 parent 83c6f3e
commit 1d5e089
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 3 deletions.
diff --git a/src/modality-specific-files/magnetic-resonance-spectroscopy.md b/src/modality-specific-files/magnetic-resonance-spectroscopy.md
@@ -179,7 +179,7 @@ A guide for using macros can be found at
 
 ### MRS-relevant fields
 
-Metadata fields that MUST, SHOULD or MAY be present:
+Metadata fields that MUST be present:
 
 <!-- This block generates a metadata table.
 These tables are defined in
@@ -190,13 +190,42 @@ A guide for using macros can be found at
  https://github.com/bids-standard/bids-specification/blob/master/macros_doc.md
 -->
 {{ MACROS___make_sidecar_table([
-  "mrs.MRSRelevantFields",
+  "mrs.MRSRequiredFields",
+  ])
+}}
+
+Metadata fields that SHOULD be present:
+
+<!-- This block generates a metadata table.
+These tables are defined in
+  src/schema/rules/sidecars
+The definitions of the fields specified in these tables may be found in
+  src/schema/objects/metadata.yaml
+A guide for using macros can be found at
+ https://github.com/bids-standard/bids-specification/blob/master/macros_doc.md
+-->
+{{ MACROS___make_sidecar_table([
+  "mrs.MRSRecommendedFields",
   "mrs.MRSRepetitionTime",
   "mrs.MRSVolumeTiming",
   "mrs.MRSConditionalNumTransients",
   "mrs.MRSIRecommendedFields",
   "mrs.MRSConditionalInversionTime",
   "mrs.MRSConditionalAnatomicalImage",
+  ])
+}}
+
+Metadata fields that MAY be present:
+
+<!-- This block generates a metadata table.
+These tables are defined in
+  src/schema/rules/sidecars
+The definitions of the fields specified in these tables may be found in
+  src/schema/objects/metadata.yaml
+A guide for using macros can be found at
+ https://github.com/bids-standard/bids-specification/blob/master/macros_doc.md
+-->
+{{ MACROS___make_sidecar_table([
   "mrs.MRSOptionalFields",
   ])
 }}

diff --git a/src/schema/rules/sidecars/mrs.yaml b/src/schema/rules/sidecars/mrs.yaml
@@ -62,14 +62,19 @@ MRSSequenceSpecifics:
     B0ShimmingTechnique: optional
     B1ShimmingTechnique: optional
 
-MRSRelevantFields:
+MRSRequiredFields:
   selectors:
     - modality == "mrs"
   fields:
     ResonantNucleus: required
     SpectrometerFrequency: required
     SpectralWidth: required
     EchoTime: required
+
+MRSRecommendedFields:
+  selectors:
+    - modality == "mrs"
+  fields:
     NumberOfSpectralPoints: recommended
     MixingTime: recommended
     FlipAngle: recommended