Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SCHEMA] harmonize into dirs, ids, ids_phenotype for "subjects" and "sessions" #1981

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

yarikoptic
Copy link
Collaborator

@yarikoptic yarikoptic commented Nov 11, 2024

Current names duplicate their "domain" (subject_ or session_), inconsistent in plurality (_id although for all ids), and not clear really what 'phenotype' corresponds to without reading the description.

With proposed change there is no duplication of the domain, consistency in plurality (albeit 'id' is an abbreviation so 'ids' is a non-word), and IMHO clearer meaning in ids_phenotype.

This would also allow for generalization across other entities in a perspective bids-standard/bids-2-devel#54 - where then any entity with folders for its level could have dirs. Also it could come handy to determine ids for some other entities in tests.

Ref: bids-standard/bids-validator#94 (comment)

TODOs

  • introduce corresponding changes to bids-validator
  • since it is a breaking change, I will boost SCHEMA_VERSION to next MINOR version.

Current names duplicate their "domain" (subject_ or session_), inconsistent in
plurality (_id although for all ids), and not clear really what
'phenotype' corresponds to without reading the description.

With proposed change there is no duplication of the domain, consistency
in plurality (albeit 'id' is an abbreviation so 'ids' is a non-word), and
IMHO clearer meaning in `ids_phenotype`.

This would also allow for generalization across other entities in a perspective
bids-standard/bids-2-devel#54 - where then any entity
with folders for its level could have `dirs`. Also it could come handy to
determine `ids` for some other entities in tests.

Ref: bids-standard/bids-validator#94 (comment)

TODOs
- [ ] introduce corresponding changes to bids-validator
@yarikoptic yarikoptic requested review from effigies and removed request for erdalkaraca November 11, 2024 23:15
@yarikoptic yarikoptic added the schema Issues related to the YAML schema representation of the specification. Patch version release. label Nov 11, 2024
@effigies effigies marked this pull request as draft November 12, 2024 18:33
@effigies
Copy link
Collaborator

Blocked on bids-standard/bids-validator#102.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
schema Issues related to the YAML schema representation of the specification. Patch version release.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants