-
Notifications
You must be signed in to change notification settings - Fork 146
New datasets for demonstrating / validating the Inheritance principle #504
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
Draft
Lestropie
wants to merge
14
commits into
bids-standard:master
Choose a base branch
from
Lestropie:inheritance_principle
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Datasets relate to restrictions on the directories in which it is permissible to place metadata files depending on their applicability.
These datasets exemplify what happens when there are entity-linked file collections intersecting across multiple entities.
Utilise tailored metadata key-values to highlight not only which metadata files are inherited from for any given data file, but also the value that should be inherited when multiple applicable key-value metadata files contain different values for the same key. Also add dataset "ipi1195v2", which has the filesystem structure of the example shown in Issue #1195, but includes key-value metadata that highlights the ambiguity that arises if trying to permit metadata overloading when there is full flexibility in applicable metadata files at a single filesystem hierarchy level.
This was referenced Jul 8, 2025
Save expected inherited metadata for more datasets to facilitate testing of pybids.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related to bids-standard/bids-specification#2155.
In looking at the specification content on the Inheritance Principle, across many versions (retrospective and speculative), it has become clear that showing exemplar filesystem structures / JSON metadata contents has been totally unfit for purpose.
Moreover, even worse, there were many circumstances that were explained in text as hypothetical modifications to the presented filesystem structures, which just opens to floodgates for confusion.
I have therefore gone to the effort of explicitly instantiating each of these examples as exemplar datasets; both what weas shown in the specification and all hypothetical manipulations thereof.
Other datasets I have specifically crafted in order to highlight what the differences in validation should be depending on which particular IP ruleset is instantiated.
One crucial detail here is that many of these examples are defined as they are specifically because they should fail validation. Am I correct in inferring that all datasets in the
bids-examples
repository should pass validation (with the potential exclusion of content not yet included in a tagged specification), and anything that fails validation should instead be going intobids-validator/tests/data
?I am also aware that the addition of these data will result in failure of
run_tests.sh
.Maintainers will need to advise on whether some of these datasets need to be moved, whether some of these datasets should be excluded from validator testing, or whether merging the PR needs to be deferred until requisite rectifications to the validator are made.