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

[ENH] Add stimulus and annotation entities #1814

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

Conversation

neuromechanist
Copy link

stimulus and annotation entities are necessary to distinguish various stimulus files and possible different annotations per each stimulus file.

A sample use-case of these entities is presented in bids-standard/bids-examples#433.

Both entities are being discussed in #153, and this Google Doc.
The stim- entity was suggested first in #751.
The annot- entity might be of use in #1771 as well.

This pull request would likely require a minor version change.

Copy link

codecov bot commented May 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.92%. Comparing base (0950f6d) to head (cee0301).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1814   +/-   ##
=======================================
  Coverage   87.92%   87.92%           
=======================================
  Files          16       16           
  Lines        1375     1375           
=======================================
  Hits         1209     1209           
  Misses        166      166           

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

The `annot-<label>` entity can be used to distinguish different annotations
of the stimulus data.

This entity is only applicable to stimulus files.
Copy link
Collaborator

Choose a reason for hiding this comment

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

A parallel to investigate here is _events.tsv files, i.e. those could also be created/annotated across various dimensions. ATM they would just "flatten" them into this single file with some column potentially disentangling those dimensions for different annotations (e.g. low level properties of visual stimuli vs higher level cognitive concepts vs responses). So it feels to me it might be applicable there too.

But with that it somewhat begs me to think about some possible alternative name/concept but I find none and there be none ;)

Copy link
Collaborator

Choose a reason for hiding this comment

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

Since we already ran into discussion either desc could be in effect used as desc (and we have example in bids of _desc-autoannot), it would be valuable to describe here the difference from desc, e.g. annot is more specialized in providing annotations to the stimuli/events whenever desc is more about processing of the data. So _annot-chatgpt would be preferable over _desc-chatgpt as would symbolize annotation over some other chatgpt driven processing (e.g. prompted chatgpt for some analysis of data/stimuli)

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

Successfully merging this pull request may close these issues.

3 participants