[FIX]: Hierarchical Event Descriptors (HED) page update #1592
Conversation
Update the HED specification page with respect to the latest HED developments, including HED-SCORE example, partnered library schemas and HED standard schema version 8.2.0.
for more information, see https://pre-commit.ci
Codecov ReportAll modified lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1592 +/- ##
=======================================
Coverage 87.83% 87.83%
=======================================
Files 16 16
Lines 1356 1356
=======================================
Hits 1191 1191
Misses 165 165 ☔ View full report in Codecov by Sentry. |
Correct for proper use of semantic line breaks.
src/appendices/hed.md
Outdated
| @@ -130,23 +179,42 @@ This allows for a proper validation of the HED annotations (for example using th | |||
| } | |||
| ``` | |||
|
|
|||
| If you omit the `HEDVersion` field from the dataset description file, a warning will be generated and any present HED information will be validated using the latest version of the HED schema. | |||
| This is bound to result in problems, and hence, it is strongly RECOMMENDED that the `HEDVersion` field be included when using HED in a BIDS dataset. | |||
| If you omit the `HEDVersion` field from the dataset description file, | |||
There was a problem hiding this comment.
I think this is not correct. I believe the current versions of the hed-validator require a HedVersion if HED is in the dataset. I will verify and get back to you @happy5214 can you comment?
There was a problem hiding this comment.
I checked with @happy5214. If your dataset has HED in it and you don't have a HEDVersion field in your dataset_description.json, an error is generated rather than making an assumption about version.
There was a problem hiding this comment.
[email protected] doesn't seem to be validating HED and the hed-examples Jupyter notebook seems to be validating against the latest version of the HED schema in case the HEDVersion field is omitted.
What version should I check this against?
Corrected typos.
Removed 'version' per PR review.
Corrected typos.
When referring to the column name, ‘duration’ is used, and when referring to the HED tag, ‘Duration’ is used.
Correcting standard schema example (validated with https://hedtools.org/hed/string)
Updated `HEDVersion` field use statement
Corrected red/blue square to match across the `events.tsv` file, accompanying `events.json` sidecar, and fully assembled annotation.
`HEDVersion` field clarification
|
Thank you @VisLab ! |
|
@VisLab which of the 3 examples is the most recent/common/recommended example? (1: Unpartnered library schema example, 2: Single unpartnered library schema example and 3: Partnered library schema). If example 3 is most common, that should probably be the first instead. |
Change per review.
|
nice to see these updates. |
sappelhoff
requested review from
monkeyman192,
ezemikulan,
sappelhoff and
CPernet
as code owners
Fix alignment Co-authored-by: Chris Markiewicz <[email protected]>
Cleaner line breaks and adding back-ticks. Co-authored-by: Chris Markiewicz <[email protected]>
Corrected 'schemas' to 'schema'
minor grammar edits
effigies
dismissed
their stale review
Merge conflicts polluting branch. See #1623 instead.
|
Do I need to address anything here? Thx |
Update the HED specification page with respect to the latest HED developments, including HED-SCORE example, partnered library schemas, and HED standard schema version 8.2.0.