[HED Tags] Address Feedback: Expanding Definitions

[jesscall]

Based on Feedback from May 15 Technical Meeting -

When viewing HED Tags, we should be able to expand definitions. This is different than toggling between short / long form.

EX (A): (Def/Face-image/Onset)

There is already an option in the HED web services events_assemble for expanding definitions (expand_defs).

EX (B) Results when expand_defs === off:

EX (C) Results when expand_defs === on:

The option for expanding definitions has been turned on in PR #769 on the LORIS-MRI repo when importing BIDS datasets. However, a distinction should be made in the database between the expanded and non-expanded definitions and only displayed conditionally based on user input.

---

The following tasks will need to be addressed in order to be able to toggle the expansion of HED definitions in the EEG Browser:

1. Incorporate support for toggling expanded HED tag definitions

• Add ExpandedHED column to the physiological_task_event table in the database.
• Amend utilities to make two requests to the events_assemble HED services: (i) request with expand_defs = off with result saved to AssembledHED column, (ii) request with expand_defs = on with result saved to the new ExpandedHED column. Update statement to database should be amended as well.
• In the EventManager, once an event's HED tag is toggled open as shown in (A) - the user should be able to click a Expand / Collapse button to toggle the definitions. Display either the AssembledHED or ExpandedHED from the database depending on whether the user has clicked expand or collapse.

2. Incorporate support for toggling individual definitions

• There is a new feature in the HED services which returns a dictionary of definitions in the response JSON object. These can be saved to the database (news tables will need to be created) and information for individual definitions can be toggled on hover as a tooltip.

[christinerogers]

This will be relevant when / if EEGNet implements support for adding custom HED tags or remodelling/lifecycle/condition tagging.
too far in future to place on the timeline as of spring 2023.