Handle channel name mismatches

[Kallemakela]

PR Description

Channels are renamed here without a warning or error when there is a mismatch between the raw data and BIDS channels.tsv. This can cause a possible mismatch between channel names and the underlying locations (raw.info['chs'][i]['loc']) and signal data (raw._data).

@larsoner proposed a fix here that was never implemented:

Yikes so there's no real way to know. Maybe we should raise an error but allow people to pass ch_name_mismatch='raise' (default) | 'reorder' | 'rename'. We could even just start with the reorder case as that's the one we actually need here, unless people already have seen datasets that need to rename one.

So I implemented it, except using 'raise' as the default. In my opinion, this makes more sense as this is a clear error in the BIDS dataset.

Maybe we should also:

• Provide an utility tool for overwriting BIDS channels.tsv files from the raw data files: example for snirf
• Update the bids validator to check for channel mismatches.

Related issues:
#1360
#1117

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>"

[welcome]

Hello! 👋 Thanks for opening your first pull request here!
Please read the contributor guide, and please follow the steps outlined in the "Instructions for first-time contributors" section therein. ❤️ We will try to get back to you soon. 🚴🏽‍♂️

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.92%. Comparing base (465dd55) to head (138e699).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1466      +/-   ##
==========================================
- Coverage   96.92%   96.92%   -0.01%     
==========================================
  Files          43       43              
  Lines       10015    10074      +59     
==========================================
+ Hits         9707     9764      +57     
- Misses        308      310       +2     

☔ 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.

[larsoner]

Otherwise I think it's good to go!

[larsoner]

@drammock feel free to merge if you're happy as well

[larsoner]

Or actually @scott-huberty you have a "changes requested", can you re-review and approve if you're happy?

[scott-huberty]

Or actually @scott-huberty you have a "changes requested", can you re-review and approve if you're happy?

enabled merged when green. Thanks @Kallemakela !

[welcome]

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

[sappelhoff]

@Kallemakela thank you so much. I think we still need to add you to https://github.com/mne-tools/mne-bids/blob/main/CITATION.cff See also https://github.com/mne-tools/mne-bids/blob/main/CONTRIBUTING.md#instructions-for-first-time-contributors