Skip to content

Add support for new MeaningsTable type in hdfm-common #284

Closed

Description

@oruebel

Overview

In hdmf-dev/hdmf-common-schema#91 the following key changes were made:

  1. added MeaningsTable as a new type
  2. updatedDynamicTable to add a sub-group for storing instances of MeaningsTable

With this design, each column in a DynamicTable may optionally have a corresponding MeaningsTable.

Approach

  • Update schema in AqNWB to support the latest hdmf-common schema. See http://nwb.org/aqnwb/nwb_schema_page.html for instructions.
  • Add new class for representing MeaningTable. See http://nwb.org/aqnwb/registered_type_page.html for instructions.
  • Update DynamicTable::initialize implement the required schema changes, in particular, creating the required meanings_tables group
  • Update DynamicTable to add the required macros (e.g., DEFINE_UNNAMED_REGISTERED_FIELD) for reading and creating MeaningsTable objects
  • Optional: Add convenience methods in DynamicTable to simplify creation of MeaningsTables for a column
  • Update the user-docs to add a tutorial on using DynamicTable and MeaningsTable, incl., adding an example in tests/examples
  • Add comprehensive unit tests for the new features
  • Update the CHANGELOG

Activity

  1. added
    topic: apiissues related to the core AqNWB API
    priority: mediumnon-critical problem and/or affecting only a small set of users
    on Feb 23, 2026
  2. added this to the 0.4.0 milestone on Feb 23, 2026
  3. linked a pull request that will close this issueAdd meanings table #302on Jul 2, 2026
  4. self-assigned this
    on Jul 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

category: enhancementproposed enhancements or new featurespriority: mediumnon-critical problem and/or affecting only a small set of userstopic: apiissues related to the core AqNWB API

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions