Skip to content

Commit

Permalink
Provide more helpful error messages when trying to write non-prelaode…
Browse files Browse the repository at this point in the history
…d concatenated data (#1075)

This came up on the forum: https://mne.discourse.group/t/mne-bids-structure-one-subject-is-different/5687/4

Co-authored-by: Stefan Appelhoff <stefan.appelhoff@mailbox.org>
  • Loading branch information
hoechenberger and sappelhoff committed Oct 8, 2022
1 parent 7b52eab commit ee27b43
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 6 deletions.
1 change: 1 addition & 0 deletions doc/whats_new.rst
Expand Up @@ -79,6 +79,7 @@ Detailed list of changes

- Until now, :class:`mne_bids.BIDSPath` prepends extensions with a period "." automatically. We intend to remove this undocumented side-effect and now emit a ``FutureWarning`` if an ``extension`` that does not start with a ``.`` is provided. Starting with MNE-BIDS 0.12, an exception will be raised in this case, by `Richard Höchenberger`_ (:gh:`1061`)

- Provide a more helpful error message when trying to write non-preloaded concatenated data, by `Richard Höchenberger`_ (:gh:`#1075`)

🛠 Requirements
^^^^^^^^^^^^^^^
Expand Down
19 changes: 13 additions & 6 deletions mne_bids/write.py
Expand Up @@ -1623,8 +1623,15 @@ def write_raw_bids(
elif format == 'FIF':
ext = '.fif'
else:
raise ValueError('For preloaded data, you must specify a valid '
'format. See "allow_preload".')
msg = (
'For preloaded data, you must set the "format" parameter '
'to one of: BrainVision, EDF, or FIF'
)
if format != 'auto': # the default was changed
msg += f', but got: "{format}"'

raise ValueError(msg)

raw_orig = raw

# Check times
Expand All @@ -1635,15 +1642,15 @@ def write_raw_bids(
else:
msg = ("The raw data you want to write contains {comp} time "
"points than the raw data on disk. It is possible that you "
"{guess} your data, which write_raw_bids() won't accept.")
"{guess} your data.")
if len(raw.times) < len(raw_orig.times):
msg = msg.format(comp='fewer', guess='cropped')
elif len(raw.times) > len(raw_orig.times):
msg = msg.format(comp='more', guess='concatenated')

msg += (' If you believe you have a valid use case that should be '
'supported, please reach out to the developers at '
'https://github.com/mne-tools/mne-bids/issues')
msg += (' To write the data, please preload it and pass '
'"allow_preload=True" and the "format" parameter to '
'write_raw_bids().')
raise ValueError(msg)

# Initialize BIDSPath
Expand Down

0 comments on commit ee27b43

Please sign in to comment.