Skip to content

Improve documentation of ElectrodeGroup #631

@h-mayorquin

Description

@h-mayorquin

We are building a tutorial on how to add ElectrodeGroup metadata in neuroconv, and the question has come up: what is the purpose of this object? Why is ElectrodeGroup special?

The documentation is not very clear about its purpose:

doc: A physical grouping of electrodes, e.g. a shank of an array.

"a physical grouping of electrodes"

The pynwb tutorial is also not very specific:

"The electrodes table references a required ElectrodeGroup, which is used to represent a group of electrodes"

@bendichter mentioned that the main use case for this object is grouping electrodes that are intended to be spike sorted together. This is a clear and helpful explanation that gives users enough context to understand how to fill in this metadata.

Should we move forward and add this clarification? Are we missing any other important use cases?

Metadata

Metadata

Assignees

No one assigned

    Labels

    topic: docsIssues related to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions