Skip to content
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.

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

Create table suggesting neurodata types for experimental data types #177

Open
rly opened this issue Nov 18, 2024 · 1 comment
Open

Create table suggesting neurodata types for experimental data types #177

rly opened this issue Nov 18, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@rly
Copy link
Contributor

rly commented Nov 18, 2024

Problem: Users do not know what neurodata type they should use for a given experimental data type.

Proposed solution: Create a table that maps neurodata type (e.g., SpatialSeries within a Position container) to experimental data types ("position data", "animal running in maze") or in the other direction. We can start building this in a Google Doc for fast iteration and then move to a PR.

cc @bendichter

@rly rly self-assigned this Nov 18, 2024
@oruebel
Copy link
Contributor

oruebel commented Nov 18, 2024

We can start building this in a Google Doc for fast iteration and then move to a PR.

Sounds good. To ease maintenance, I'm wondering whether it may be best to have this as a TSV in the schema repo. In that way we could make it required to update the table when modifying the schema. We could then also more easily render the table in multiple places (e.g., in tutorials in the PyNWB and MatNWB docs) without having to maintain it in multiple places.

@stephprince stephprince added the documentation Improvements or additions to documentation label Nov 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants