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] describing fields in event.json file #1255

Merged
merged 13 commits into from
May 28, 2024
Merged

Conversation

JuliusWelzel
Copy link
Contributor

@JuliusWelzel JuliusWelzel commented May 27, 2024

PR Description

As currently implemented, the events.json file being written does not contain information about the two required columns "onset" and "duration" in the .json file.

As those columns are REQURIED, I would propose adding some background information to the .json file every time events are written for people who are not familiar with the structure of the events.tsv files in.REQUIRED.

See #1254 for details.

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 May 27, 2024

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

mne_bids/write.py Outdated Show resolved Hide resolved
mne_bids/write.py Outdated Show resolved Hide resolved
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.

Thanks @JuliusWelzel I merged main into your branch, so please pull before continuing to work on this (main contains some CI fixes now).

As for your PR, I am happy with the proposed changes, but please observe my comments in the code.

Finally, please follow the steps in the second to last section of this document: https://github.com/mne-tools/mne-bids/blob/main/CONTRIBUTING.md#instructions-for-first-time-contributors

mne_bids/write.py Outdated Show resolved Hide resolved
mne_bids/write.py Outdated Show resolved Hide resolved
@sappelhoff sappelhoff added this to the 0.16 milestone May 28, 2024
Copy link

codecov bot commented May 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.45%. Comparing base (87eea28) to head (3a37466).
Report is 25 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1255      +/-   ##
==========================================
- Coverage   97.61%   97.45%   -0.17%     
==========================================
  Files          40       40              
  Lines        8685     8685              
==========================================
- Hits         8478     8464      -14     
- Misses        207      221      +14     

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

@JuliusWelzel
Copy link
Contributor Author

Hopefully all done, so should be good to go

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.

one last thing to do, the rest looks great -- thanks

CITATION.cff Outdated Show resolved Hide resolved
@sappelhoff sappelhoff merged commit c87a823 into mne-tools:main May 28, 2024
19 of 20 checks passed
Copy link

welcome bot commented May 28, 2024

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

@sappelhoff
Copy link
Member

Thanks @JuliusWelzel!

@sappelhoff sappelhoff modified the milestones: 0.16, 0.15 May 28, 2024
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.

Add descriptions for onset and duration in event.json file
3 participants