Support strings for marker descriptions

[cbrnr]

Currently, we only support integer marker descriptions for "Stimulus" and "Response" marker types. String descriptions are only possible with "Comment" types.

This is a serious restriction, because it can lead to loss of information. I suggest that we also allow string descriptions for "Stimulus" and "Response" markers, which would allow us to just use the original (e.g. mne.Annotations) description.

Note that the specs do not contain our restriction at all. I already discussed this with my contact at BrainProducts, he says that this is a convention originated from their recorder software (which uses individual trigger lines). The format itself does not mandate integer marker descriptions at all (which was already mentioned here).

[sappelhoff]

he says that this is a convention originated from their recorder software (which uses individual trigger lines).

indeed, this is the main reason why we have this restriction currently. As long as this feature will be well tested and does not lead to compatibility issues, I fully agree with it.

[cbrnr]

How do you want to handle this? I'd put no restrictions on type and description. Instead, I would write markers exactly as passed to the function (when passed a list of dicts, when passed an events array nothing needs to be adapted). So no conversions to "S 1" etc. when passing a list of dicts.

[sappelhoff]

So no conversions to "S 1" etc. when passing a list of dicts.

but leave that conversion intact when an events array is passed? 🤔

I think that may be fine.

[cbrnr]

Yes exactly. We might even consider splitting this into two parameters:

• events: only accepts 2D arrays and has (some of) our conversions in place
• markers: the list of dicts, which writes types and descriptions as is

[sappelhoff]

okay for the above, but I wouldn't split events into two parameters as I find it more clear to have the controls of how to write this information in one place.

[cbrnr]

If we disable all checks regarding marker type and description when passing a list of dicts, we run into the problem that many (all?) tests currently use events passed as a list of dicts.

Should we introduce a new parameter to enable writing arbitrary marker types/descriptions? Or should we adapt our tests and pass an array (which still does the checks)?

[sappelhoff]

I would naively say let's try to avoid another parameter, but if you are about to do the work and see that that's completely unreasonable, I also trust you with that and will be happy to review either way!