dataset

parseDefinitions(parsedHedStrings)

Parse the dataset’s definitions and evaluate labels in the dataset.

Arguments:

  • parsedHedStrings (Array.<ParsedHedString>) – The dataset’s parsed HED strings.

Returns:

checkGroupForTemporalOrder(parsedGroup, activeScopes)

Check a parsed HED group for its onset and offset ordering.

Arguments:

  • parsedGroup (ParsedHedGroup) – A parsed HED group.

  • activeScopes (Set.<string>) – The active duration scopes, represented by the groups’ canonical Def tags.

Returns:

Array.<Issue> – Any issues found.

validateTemporalOrder(hedStrings, hedSchemas)

Validate onset and offset ordering.

Arguments:

  • hedStrings (Array.<ParsedHedString>) – The dataset’s HED strings.

  • hedSchemas (Schemas) – The HED schema container object.

Returns:

Array.<Issue> – Any issues found.

validateDataset(definitions, hedStrings, hedSchemas)

Perform dataset-level validation on a HED dataset.

Arguments:

  • definitions (Definitions) – The parsed dataset definitions.

  • hedStrings (Array.<ParsedHedString>) – The dataset’s HED strings.

  • hedSchemas (Schemas) – The HED schema container object.

Returns:

Array.<Issue> – Whether the HED dataset is valid and any issues found.

validateHedEvents(parsedHedStrings, hedSchemas, definitions, settings)

Validate a group of HED strings.

Arguments:

  • parsedHedStrings (Array.<string>|Array.<ParsedHedString>) – The dataset’s parsed HED strings.

  • hedSchemas (Schemas) – The HED schema container object.

  • definitions (Map.<string, ParsedHedGroup>) – The dataset’s parsed definitions.

  • settings (Object) – The configuration settings for validation.

Returns:

validateHedDataset(hedStrings, hedSchemas, checkForWarnings)

Validate a HED dataset.

Arguments:

  • hedStrings (Array.<string>) – The dataset’s HED strings.

  • hedSchemas (Schemas) – The HED schema container object.

  • checkForWarnings (boolean) – Whether to check for warnings or only errors.

Returns:

validateHedDatasetWithContext(hedStrings, contextHedStrings, hedSchemas, checkForWarnings)

Validate a HED dataset with additional context.

Arguments:

  • hedStrings (Array.<string>) – The dataset’s HED strings.

  • contextHedStrings (Array.<string>) – The dataset’s context HED strings.

  • hedSchemas (Schemas) – The HED schema container object.

  • checkForWarnings (boolean) – Whether to check for warnings or only errors.

Returns: