Skip to content

[ENH] Updated HED Version to 8.4.0 in examples #2237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

[ENH] Updated HED Version to 8.4.0 in examples #2237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
66d2e06
Updated HED Version in spec to 8.4.0
VisLab Oct 27, 2025
2a36d0c
Update src/appendices/hed.md
VisLab Oct 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 13 additions & 14 deletions src/appendices/hed.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,16 +168,16 @@ This allows for properly validating the HED annotations
(for example, using the `bids-validator`).

**Example:** The following `dataset_description.json` file specifies that the
[`HED8.2.0.xml`](https://github.com/hed-standard/hed-schemas/blob/main/standard_schema/hedxml/HED8.2.0.xml)
[`HED8.4.0.xml`](https://github.com/hed-standard/hed-schemas/blob/main/standard_schema/hedxml/HED8.4.0.xml)
file from the `standard_schema/hedxml` directory of the
[`hed-schemas`](https://github.com/hed-standard/hed-schemas)
repository on GitHub should be used to validate the study event annotations.

```JSON
{
"Name": "A great experiment",
"BIDSVersion": "1.8.0",
"HEDVersion": "8.2.0"
"BIDSVersion": "1.10.1",
"HEDVersion": "8.4.0"
}
```

Expand Down Expand Up @@ -210,8 +210,8 @@ A given library schema version is either partnered or standalone.
unpartnered is fixed when the library is released and cannot be changed.
For example,
[HED-SCORE version 1.0.0](https://github.com/hed-standard/hed-schemas/blob/main/library_schemas/score/hedwiki/HED_score_1.0.0.mediawiki)
is unpartnered, but [HED-SCORE version 1.1.0](https://github.com/hed-standard/hed-schemas/blob/main/library_schemas/score/hedwiki/HED_score_1.1.0.mediawiki)
is partnered with standard schema version 8.2.0.
is unpartnered, but [HED-SCORE version 2.1.0](https://github.com/hed-standard/hed-schemas/blob/main/library_schemas/score/hedwiki/HED_score_2.1.0.mediawiki)
is partnered with standard schema version 8.4.0.

##### Unpartnered library schema example

Expand All @@ -224,8 +224,8 @@ for clinical neurological annotation located at
```JSON
{
"Name": "A great experiment",
"BIDSVersion": "1.7.0",
"HEDVersion": ["8.1.0", "sc:score_1.0.0"]
"BIDSVersion": "1.10.1",
"HEDVersion": ["8.4.0", "sc:score_1.0.0"]
}
```
The `sc:` is a user-chosen prefix used to distinguish the source schemas
Expand All @@ -250,7 +250,7 @@ The following `dataset_description.json` indicates that only the HED-SCORE libra
```JSON
{
"Name": "A great experiment",
"BIDSVersion": "1.7.0",
"BIDSVersion": "1.10.1",
"HEDVersion": "score_1.0.0"
}
```
Expand All @@ -265,20 +265,19 @@ Eye-blink-artifact, Seizure-PNES

The following `dataset_description.json` file specifies that
the HED-SCORE library schema
[version 1.1.0](https://github.com/hed-standard/hed-schemas/blob/main/library_schemas/score/hedwiki/HED_score_1.1.0.mediawiki) is used.
[version 2.1.0](https://github.com/hed-standard/hed-schemas/blob/main/library_schemas/score/hedwiki/HED_score_2.1.0.mediawiki) is used.
This particular library schema version is partnered with the standard schema version
[8.2.0](https://github.com/hed-standard/hed-schemas/blob/main/standard_schema/hedxml/HED8.2.0.xml).
[8.4.0](https://github.com/hed-standard/hed-schemas/blob/main/standard_schema/hedxml/HED8.4.0.xml).

```JSON
{
"Name": "A great experiment",
"BIDSVersion": "1.8.0",
"HEDVersion": "score_1.1.0"
"BIDSVersion": "1.10.1",
"HEDVersion": "score_2.1.0"
}
```
The corresponding annotations in the dataset use tags from the
HED-SCORE library schema (`Eye-blink-artifact` and `Seizure-PNES`) and from the standard HED (`Data-feature`)
as follows:
HED-SCORE library schema (`Seizure-PNES`) and from the standard HED (`Data-feature` and `Eye-blink-artifact`) as follows:

```Text
Data-feature, Eye-blink-artifact, Seizure-PNES
Expand Down
4 changes: 2 additions & 2 deletions src/modality-agnostic-files/dataset-description.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Example:
```JSON
{
"Name": "The mother of all experiments",
"BIDSVersion": "1.6.0",
"BIDSVersion": "1.10.1",
"DatasetType": "raw",
"License": "CC0",
"Authors": [
Expand All @@ -87,7 +87,7 @@ Example:
"Alzheimer A., & Kraepelin, E. (2015). Neural correlates of presenile dementia in humans. Journal of Neuroscientific Data, 2, 234001. doi:1920.8/jndata.2015.7"
],
"DatasetDOI": "doi:10.0.2.3/dfjj.10",
"HEDVersion": "8.0.0",
"HEDVersion": "8.4.0",
"GeneratedBy": [
{
"Name": "reproin",
Expand Down