[SCHEMA] Separate schema object definitions from rules#834
[SCHEMA] Separate schema object definitions from rules#834tsalo wants to merge 8 commits intobids-standard:masterfrom
Conversation
| @@ -1,307 +1,26 @@ | |||
| This file simply defines the order in which entities should appear within filenames. | |||
There was a problem hiding this comment.
Might need to be renamed so it doesn't conflict with the entities folder.
| --- | ||
| # Metadata rules that apply to all/most MRI data types |
There was a problem hiding this comment.
Would love input on this general structure.
| SequenceName: recommended | ||
| PulseSequenceDetails: recommended | ||
|
|
||
| # Required if PET data are present |
| MRAcquisitionType: recommended | ||
| MTState: recommended | ||
|
|
||
| # Required if MTState is True |
| @@ -0,0 +1,25 @@ | |||
| --- | |||
There was a problem hiding this comment.
This isn't anywhere close to something usable, but I'm not sure what we can do here.
| DelayAfterTrigger: recommended | ||
| # Above commented-out requirements overriden by the logic below, | ||
| # along with SliceTiming from the generic MRI metadata rules. | ||
| oneOf: |
|
@tsalo I am currently experimenting with the schema and think it would be better to have the entities as an array at the top level of the entities.yaml files. would become It is also a bit confusing to have the whole object being called an "entity", then have one of its properties also named "entitiy". |
I really would prefer to separate the object definitions into separate files. Hypothetically, we could have one YAML file for each type of object (metadata fields, data types, suffixes, etc.), but I would like to avoid massive files for now. While
That's reasonable. I know that others have raised concerns with the field names in the entity definitions. I'd prefer to have that in a separate PR though, since hopefully this one will be more about reorganization and the addition of rules than redefining the objects. |
|
I'm closing this in favor of a more limited version that doesn't include pseudo-code rules. |
Closes #603. This is still a WIP.
The original scope of this PR was to reorganize the entities to follow a similar convention to the suffixes and metadata fields within the schema.
Changes proposed:
entities.yamlfile to entity-specific files in theentities/folder.entities.yamlto define the order in which entities should appear.objects/folder.rules/folder.Reorganized structure: