mne-tools / mne-bids

MNE-BIDS is a Python package that allows you to read and write BIDS-compatible datasets with the help of MNE-Python.
https://mne.tools/mne-bids/
BSD 3-Clause "New" or "Revised" License
126 stars 84 forks source link

[ADD] describing fields in `event.json` file #1255

Closed JuliusWelzel closed 1 month ago

JuliusWelzel commented 2 months ago

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 https://github.com/mne-tools/mne-bids/issues/1254 for details.

Merge checklist

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

welcome[bot] commented 2 months ago

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

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

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

Additional details and impacted files ```diff @@ 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 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

JuliusWelzel commented 1 month ago

Hopefully all done, so should be good to go

welcome[bot] commented 1 month ago

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

sappelhoff commented 1 month ago

Thanks @JuliusWelzel!