Skip to content

[ENH] Define "phenotype" as a data type not nested inside subjects #2050

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

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

Conversation

effigies
Copy link
Collaborator

Closes #1828. Please continue the conversation in that issue, and reserve this PR for discussing concrete changes.

@yarikoptic
Copy link
Collaborator

attn @bids-standard/bep036

@effigies effigies force-pushed the feat/phenotype-datatype branch from f64abd7 to d85831e Compare March 3, 2025 14:39
@effigies effigies force-pushed the feat/phenotype-datatype branch from d85831e to f5a4863 Compare March 20, 2025 19:48
Copy link

codecov bot commented Mar 20, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.71%. Comparing base (0fdcbd8) to head (b9e272a).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2050      +/-   ##
==========================================
+ Coverage   82.65%   82.71%   +0.05%     
==========================================
  Files          17       17              
  Lines        1534     1533       -1     
==========================================
  Hits         1268     1268              
+ Misses        266      265       -1     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@effigies effigies added this to the 1.10.1 milestone Apr 18, 2025
@effigies effigies force-pushed the feat/phenotype-datatype branch from f5a4863 to b9e272a Compare April 18, 2025 13:24
@effigies
Copy link
Collaborator Author

@yarikoptic @ericearl @surchs I believe that this and the issue (#1828) have had enough time to garner negative comments, so I would like to proceed by consensus. I think this would be a useful addition for consistency within the schema and would appreciate a review.

Copy link
Collaborator

@ericearl ericearl left a comment

Choose a reason for hiding this comment

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

lgtm

@@ -44,6 +43,11 @@ data_type:

14. `mrs` (magnetic resonance spectroscopy)

15. `phenotype` (participant-level measurement and survey data)
Copy link
Collaborator

Choose a reason for hiding this comment

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

so it would be coming under a session folder if it is a dataset where there is a session folder for a subject, right? so it would not be "participant-level" but "session-level"? then I would just KISS:

Suggested change
15. `phenotype` (participant-level measurement and survey data)
15. `phenotype` (measurement and survey data)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

No, the whole idea is that this doesn't change the meaning of phenotype, it slightly broadens the notion of datatype. This does not permit phenotype directories in sessions.

Copy link
Collaborator

Choose a reason for hiding this comment

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

but they are becoming (or already?) allowed at subject level so I could have sub-1/phenotype/ in addition to e.g. sub-1/ses-1? if not, then it is still located at "dataset level" (as in https://bids-specification.readthedocs.io/en/stable/modality-agnostic-files.html#phenotypic-and-assessment-data) and "participant-level" is confusing here... then

Suggested change
15. `phenotype` (participant-level measurement and survey data)
15. `phenotype` (participant-level measurement and survey data at dataset level phenotype/)

or alike to clear it up?

Comment on lines +46 to +51
15. `phenotype` (measurement and survey data)

For files that are subject- and session- specific, the data type directory
is nested inside those directories.
`phenotype` data files are aggregated across subjects and sessions,
and so the `phenotype/` directory is placed in the dataset root.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@yarikoptic @ericearl Hopefully this is clearer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Classify "phenotype/" as a datatype directory with no subject/session parent
3 participants