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

Add descriptions.tsv to the schema #1707

Merged
merged 9 commits into from
Apr 16, 2024

Conversation

tsalo
Copy link
Member

@tsalo tsalo commented Feb 15, 2024

Closes none, but continues from #1613.

I didn't figure out how to render the filenames in a macro. I think allowing descriptions.tsv files at the subject or session level introduced more complexity than it was worth, unfortunately.

I also haven't figured out how to add meaningful rules about the file to the schema. Specifically, we probably want to raise a warning if any desc values described in the file aren't in the dataset, or vice versa.

Changes proposed:

  • Add the descriptions.tsv file to the schema.

@tsalo tsalo added derivatives schema Issues related to the YAML schema representation of the specification. Patch version release. labels Feb 15, 2024
@tsalo tsalo requested a review from erdalkaraca as a code owner February 15, 2024 16:54
@tsalo tsalo marked this pull request as draft February 15, 2024 18:03
@tsalo
Copy link
Member Author

tsalo commented Feb 15, 2024

Switching to a draft until I figure out how to render the filename template.

@tsalo
Copy link
Member Author

tsalo commented Feb 15, 2024

I've given up on rendering the template with a macro, but I'll bring up adding checks for the file in the schema meeting today.

Presumably we would want rules to check if all desc-<label> entities are reflected in the file and that no definitions are included that aren't present in the dataset. Both should probably be warnings, rather than errors.

Copy link
Collaborator

@effigies effigies left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

src/schema/objects/files.yaml Outdated Show resolved Hide resolved
@tsalo tsalo marked this pull request as ready for review February 20, 2024 21:54
Copy link

codecov bot commented Feb 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.93%. Comparing base (09ba933) to head (f756906).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1707   +/-   ##
=======================================
  Coverage   87.93%   87.93%           
=======================================
  Files          16       16           
  Lines        1351     1351           
=======================================
  Hits         1188     1188           
  Misses        163      163           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

descriptions is a suffix, rather than a file.
@tsalo
Copy link
Member Author

tsalo commented Feb 22, 2024

I will open an issue about my two pain points:

  • Filename template building isn't working.
  • Rules/checks not implemented in schema.

EDIT: I've opened #1710.

Copy link
Member

@sappelhoff sappelhoff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

approving for merge as soon as "good enough" and to then cover the pain points in a follow-up (or several).

@Remi-Gau
Copy link
Collaborator

@tsalo
Can't remember if there is a reason this was not merged?

@tsalo
Copy link
Member Author

tsalo commented Apr 16, 2024

No reason- I didn't realize I had two approvals. I'll update from main and then merge once CI passes.

@tsalo tsalo merged commit 37b11ec into bids-standard:master Apr 16, 2024
26 checks passed
@tsalo tsalo deleted the schema-descriptions-tsv branch April 16, 2024 20:43
@sappelhoff sappelhoff added the exclude-from-changelog This item will not feature in the automatically generated changelog label Jun 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
derivatives exclude-from-changelog This item will not feature in the automatically generated changelog 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.

4 participants