[FIX] Standardise use of "entity" definition across specification #1
Conversation
| key/value pair corresponds to modality suffix, | ||
| such as T1w or inplaneT1, referenced by the defacemask image. | ||
| entity corresponds to modality suffix, | ||
| such as `T1w` or `inplaneT1`, referenced by the defacemask image. |
There was a problem hiding this comment.
Note: unrelated formatting change
Lestropie
force-pushed
the
replace_keyvalue_entity
branch
from
39e9d9e
to
34c85b6
Compare
|
There were uses of "key-value-pairs", "key-value", "key:value", "key/value", "keyword-value", and "parameter" all being used to refer to entities. |
There was a problem hiding this comment.
this is great, thanks a lot @Lestropie - would you mind opening a PR to bids-specification with this?
While I can definitely see a potential benefit in providing hyperlinks to the "Common principles - Definitions" entries whenever these defined terms are used in the spec, that's likely a much larger changeset, so may be deferred to a separate Issue at bids-standard/bids-specification if there is interest.
agreed!
Plan was to merge this first, and it would then be integrated into bids-standard#947, as this PR targets the base branch of that PR. I can't currently propose this change as a standalone PR on bids-specification, as there is no suitable base branch on the upstream repo for construction of such. Are you happy for this to be integrated into bids-standard#947, or would you prefer to go through the gymnastics of having essentially this same proposal as a standalone over on bids-standard/bids-specification? |
no, that seems fine to me. No additional gymnastics needed. |
ENH: Remove Atlas metadata, update imaging derivatives text around seg-
Relates to discussion in bids-standard#947.
Consistently using the term "entity" to refer to key-value pairs within filenames provides a disambiguation from key-values that are stored in sidecar metadata files.
While I can definitely see a potential benefit in providing hyperlinks to the "Common principles - Definitions" entries whenever these defined terms are used in the spec, that's likely a much larger changeset, so may be deferred to a separate Issue at bids-standard/bids-specification if there is interest.