Standard:
HED (Hierarchical Event Descriptors) is an evolving framework for the description and formal annotation of events and other information in data. The HED ecosystem includes a structured vocabulary (specified by a HED schema) together with tools for validation and for using HED annotations in data search, extraction, and analysis.
While HED can be used to annotate any type of data, the current HED community focuses on annotation of events in human neuroimaging and behavioral data such as EEG, MEG, iEEG, fMRI, eye-tracking, motion-capture, EKG, and audiovisual recording.
See the HED project homepage and HED resources, particularly the How do you use HED? for information about how to get started or how to get involved in the HED community.
The HED schemas are hierarchically-structured vocabularies for annotating data. The HED ecosystem includes a standard schema containing the basic vocabulary needed for annotation of experimental data as well as specialized library schemas for the additional field-specific terms needed to complete an annotation.
All released and prereleased versions of the HED schemas can be viewed the HED Schema Browser.
The following table summarizes the current versions of the HED schemas.
| Schema | Latest version |
Description | Prerelease version |
DOI |
|---|---|---|---|---|
| standard | 8.2.0 | Basic vocabulary for annotating data. | 8.3.0 | 10.5281/zenodo.7876037 |
| score | 1.1.0 | SCORE standard vocabulary for clinical neurological annotation (See Score docs.) |
1.1.1 | 10.5281/zenodo.7897596 |
| lisa | LISA linguistic stimuli annotation vocabulary. | 0.0.1 | ||
| testlib | 2.0.0 | A copy of the HED standard vocabulary for testing. (May not be stable.) |
2.0.1 |
HED schemas are stored in two formats: .mediawiki and .xml.
The .mediawiki Markdown format is used by schema developers to create and
maintain HED schemas. For each schema, the .mediawiki versions are
stored in the respective .mediawiki directory for the schema.
The .mediawiki format is converted to an equivalent
.xml format for use with all HED analysis and validation tools.
For each schema, the .xml versions are
stored in the respective .xml directory for the schema.
An online schema conversion tool is available at as part of the
HED online tools.
If you want to suggest a new feature or a change to the standard HED schema or one of the HED library schemas, just post an issue to this repository, and it will find its way to the right place.
As modifications to a HED schema are proposed, they are entered into the
PROPOSED.md document in the schema's respective directory for discussion.
Approved changes and corrections are first made in a working version of the
schema that is located in the prerelease subdirectory.
Upon final review, the new HED schema is released and moved to the
hedxml directory of the respective library schema.
For a more complete view of the process see the HED schema developer's guide.
The GUI tool CTagger is available to help users with the annotation process. CTagger can be used as a standalone application or can be called from EEGLAB via the hedtools plug-in to annotate an EEGLAB dataset/STUDY directly. Please refer to the linked repositories for more documentation on how to start HED-tagging using CTagger.
The current online HED tools include an online validator of spreadsheets (Excel or tsv)
containing HED tags.
Schema tools are available for validating and converting HED schema specifications between .mediawiki and .xml formats.
The released version of the web-based HED tools is located at https://hedtools.org. The development version of the tools, used to test features before release, is located at https://hedtools.org/hed_dev.
HED schemas use the following rules for changing the major.minor.patch semantic version. These rules are based on the assumption that annotators using the HED tag short form will not have to retag their data for patch-level or minor-version changes of the schema. That is, a dataset tagged using schema version X.Y.Z will also validate for X.Y+.Z+. In addition, validation errors might occur during for patch-level or minor-version changes for changes or corrections in tag values or units.
Here is a summary of the types of changes that correspond to different levels of changes in the semantic version:
| Change | Semantic-level |
|---|---|
| Major addition to HED functionality | Major |
| Tag deleted from schema. | Major |
| Unit or unit class removed from node. | Major |
| Node attribute value changed | Minor |
| Inherited attribute change | Minor |
| New property added to or removed from schema | Minor |
| New value class added to schema | Minor |
| New unit modifier added to schema | Minor |
| New tag added to the schema. | Minor |
| New attribute added to schema. | Minor |
| New unit class or unit added to schema. | Minor |
| New unit class added to node. | Minor |
| New value class added to node. | Minor |
| Node moved in schema without change in meaning. | Minor |
| Revision of description field in schema. | Patch |
| Correction of suggestedTag or relatedTag. | Patch |
Note: It is an official policy that once in a schema, a node will not be removed without
a major schema version change.
If a node becomes out-of-date, a deprecated attribute will be added to the tag in the schema.
Suggested replacement tags should be included in the node description.
A suggested replacement should be added to the tag patch table.
The HED system has gone through two major restructurings since the original system (HED-1G) was introduced. The following table shows the correspondence between HED schema version number and the design generation.
| schema version | release date | HED generation |
|---|---|---|
| 1.0 | 2011-01-01 | HED-1G |
| 4.0.0 | 2016-02-25 | HED-2G |
| 8.0.0 | 2021-08-07 | HED-3G |
HED-1G introduced the basic ideas of annotation using path strings and is still in use in the HEADIT archive.
A major redesign of HED, HED-2G released in 2016 (4.0.0 <= schema version < 8.0.0), orthogonalized the vocabulary terms and introduced parentheses for grouping modifiers with the terms they modify, resulting in much improved annotation.
The second majoring restructuring, HED-3G (7.x.x < schema version), has resulted in a dramatic improvement in capabilities, including the introduction of annotations of condition variables and experimental design within the data as well as the ability to handle event context and events with temporal extent.
Stable directory link for software requiring a HED standard schema for validation.
Stable link for the latest version of the HED standard schema.
The full HED specification is available at the HED specification website.
Efforts are underway to map HED to a formal ontology in order to leverage links to other terminologies and vocabularies. The development effort is housed on the hed-ontology GitHub repository.