Skip to content

[MRG] Improve error message raised on channels missing from DigMontage #11472

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.

Sign up for GitHub

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

Merged
larsoner merged 4 commits into from
Feb 15, 2023
Merged

[MRG] Improve error message raised on channels missing from DigMontage #11472

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c120b85
rephrase error message
mscheltienne Feb 14, 2023
2489ce3
Update mne/channels/montage.py
mscheltienne Feb 14, 2023
2ec2f3a
reorder lines
mscheltienne Feb 14, 2023
a9467b6
Merge remote-tracking branch 'upstream/main' into montage_msg
mscheltienne Feb 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions mne/channels/montage.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1183,14 +1183,17 @@ def _backcompat_value(pos, ref_pos):
missing = np.where([use not in ch_pos for use in info_names_use])[0]
if len(missing): # DigMontage is subset of info
missing_names = [info_names[ii] for ii in missing]
pl = _pl(missing)
are_is = "are" if pl else "is"
missing_coord_msg = (
'DigMontage is only a subset of info. There are '
f'{len(missing)} channel position{_pl(missing)} '
'not present in the DigMontage. The required channels are:\n\n'
f'{missing_names}.\n\nConsider using inst.set_channel_types '
'if these are not EEG channels, or use the on_missing '
'parameter if the channel positions are allowed to be unknown '
'in your analyses.'
f"DigMontage is only a subset of info. There {are_is} "
f"{len(missing)} channel position{pl} not present in the "
f"DigMontage. The channel{pl} missing from the montage {are_is}:"
f"\n\n{missing_names}.\n\nConsider using inst.rename_channels to "
"match the montage nomenclature, or inst.set_channel_types if "
f"{'these' if pl else 'this'} {are_is} not {'' if pl else 'an '}"
f"EEG channel{pl}, or use the on_missing parameter if the channel "
f"position{pl} {are_is} allowed to be unknown in your analyses."
)
_on_missing(on_missing, missing_coord_msg)

Expand Down