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 event metadata handling #1285

Merged
merged 10 commits into from
Aug 23, 2024
Merged

Conversation

thht
Copy link
Contributor

@thht thht commented Aug 5, 2024

PR Description

So far, mne-bids only uses event_id to handle events. However, we really like and use the event metadata functionality of MNE Python. So, here is an update that you can also use event metadata as an alternative.

Merge checklist

Maintainer, please confirm the following before merging.
If applicable:

  • All comments are resolved
  • This is not your own PR
  • All CIs are happy
  • PR title starts with [MRG]
  • whats_new.rst is updated
  • New contributors have been added to CITATION.cff
  • PR description includes phrase "closes <#issue-number>"

Copy link

welcome bot commented Aug 5, 2024

Hello! 👋 Thanks for opening your first pull request here! ❤️ We will try to get back to you soon. 🚴🏽‍♂️

@sappelhoff
Copy link
Member

Hi @thht, I just had a quick glance and it already looks very clean and reasonable!

Please also follow the steps described here (in particular a changelog item with a high level description of your addition):

https://github.com/mne-tools/mne-bids/blob/main/CONTRIBUTING.md#instructions-for-first-time-contributors

And tag me for a review once you are ready 🙏

@thht thht force-pushed the add_event_metadata_handling branch from 1d5136d to 424f575 Compare August 6, 2024 08:01
@thht thht marked this pull request as ready for review August 6, 2024 08:20
@thht
Copy link
Contributor Author

thht commented Aug 6, 2024

@sappelhoff Thanks for the quick reply!

As you can see, I added the authors, citation and changelog information. I also fixed the docs issue.

Failing tests should be due to the bids-validator issue you already reported in #1287.

So, I think, this one is ready for review!

@sappelhoff sappelhoff added this to the 0.16 milestone Aug 6, 2024
@thht thht force-pushed the add_event_metadata_handling branch from 9fefedd to a85c7ab Compare August 6, 2024 16:22
Copy link

codecov bot commented Aug 23, 2024

Codecov Report

Attention: Patch coverage is 97.10145% with 2 lines in your changes missing coverage. Please review.

Project coverage is 97.45%. Comparing base (87eea28) to head (5544cd4).
Report is 59 commits behind head on main.

Files Patch % Lines
mne_bids/write.py 91.30% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1285      +/-   ##
==========================================
- Coverage   97.61%   97.45%   -0.16%     
==========================================
  Files          40       40              
  Lines        8685     8779      +94     
==========================================
+ Hits         8478     8556      +78     
- Misses        207      223      +16     

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

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.

I am very happy with this, thanks a lot!

@sappelhoff sappelhoff merged commit 471bd0c into mne-tools:main Aug 23, 2024
22 of 24 checks passed
Copy link

welcome bot commented Aug 23, 2024

🎉 Congrats on merging your first pull request! 🥳 Looking forward to seeing more from you in the future! 💪

@thht thht deleted the add_event_metadata_handling branch August 23, 2024 13:11
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.

2 participants