This package contains a JavaScript validator for HED (Hierarchical Event Descriptor) strings.
HED is a system for annotating events using comma-separated path strings. Any type of event can be annotated using HED-type syntax. The HED annotation strategy is very general and a standardized vocabulary in the form of a HED schema enables annotation of events in an understandable, machine-actionable format.
The current focus of the hed-validator package is to support full validation of HED in
BIDS datasets under the BIDS validator 2.0.
HED validation is currently also supported in an online version of the HED validator, which is implemented in Python and developed in a public GitHub repository. Validation and other HED operations are also available through web-services and a docker module.
The JavaScript version of the HED validator, implemented in this package, is meant primarily to be called during validation of BIDS datasets and is called by the bids-validator. This package has been deployed on npm as hed-validator.
To use the hed-validator, you must install the npm hed-validator package and add:
import hedValidator from 'hed-validator' to your JavaScript program.
A sample of current hed-validator usage can be found in the BIDS validator in
hed.js.
The develop branch is now the default branch. All changes to the repository should
be done as PRs (pull requests) to the develop branch.