Skip to content

Make *ChannelCount metadata OPTIONAL instead of RECOMMENDED #1277

Open
@sappelhoff

Description

@sappelhoff

For example, the EEGChannelCount metadata should be an integer that corresponds to the count of channels with type EEG in the channels.tsv file.

This metadata is currently not validated with bids-validator (and never has been): https://github.com/bids-standard/bids-validator/issues/673

The basic validation step would be to "count" the channel types in channels.tsv and compare it to the metadata in the *.json files. This would be possible to implement, and we can (should) add this feature in the future.

However, here I am advocating (nudged by @effigies) for making the *ChannelCount metadata OPTIONAL instead of RECOMMENDED throughout the spec. Reasons apart from those outlined in #802 (review) include that it is inconsistent to have the *ChannelCount metadata only for some specific channel types, and not all channel types. This has lead to misunderstandings in the past, but unfortunately I cannot find the issue(s) just now.

Practically the proposed (backward compatible!) change has only an impact on how future validation proceeds:

  • for RECOMMENDED items, we warn if the item is not specified
  • for OPTIONAL items, we do not warn if the item is not specified

I think the second option is more appropriate.

Metadata

Metadata

Assignees

No one assigned

    Labels

    EEGElectroencephalographyMEGMagnetoencephalographydiscussionongoing discussioniEEG

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions