Skip to content

Commit 5ba8f07

Browse files
Fix schema column descriptions and clarify events requirements
Based on review feedback: - Update HED column: 'HED Tag' → 'HED' display name, 'Tag' → 'tags' in description - Fix stim_file path: /stimuli → /stimuli/ to prevent line breaks - Add comma after 'sequence has started' for clarity - Clarify events file requirements: 'at least one corresponding data file' - Better explain inheritance principle for events files
1 parent 49940de commit 5ba8f07

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

src/modality-agnostic-files/events.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ duration).
2020
)
2121
}}
2222

23-
Each `events.tsv` file REQUIRES a corresponding data file.
24-
It is also possible to have a single `events.tsv` file describing events
25-
for all participants and runs (see
26-
[Inheritance Principle](../common-principles.md#the-inheritance-principle)).
23+
Each `events.tsv` file REQUIRES at least one corresponding data file.
24+
Through the [Inheritance Principle](../common-principles.md#the-inheritance-principle),
25+
a single `events.tsv` file MAY describe events for multiple participants,
26+
sessions, and runs.
2727
As with all other tabular data, `events.tsv` files MAY be accompanied
2828
by a JSON file describing the columns in detail
2929
(see [Tabular Files](../common-principles.md#tabular-files)).
@@ -61,7 +61,7 @@ SHOULD be documented in an accompanying JSON sidecar file.
6161
if any acquired scans have been discarded before forming the imaging data file,
6262
ensure that an `onset` of 0 corresponds to the time the first image was stored.
6363
For example in case there is an in scanner training phase that
64-
begins before the scanning sequence has started events from this sequence should
64+
begins before the scanning sequence has started, events from this sequence should
6565
have negative onset time counting down to the beginning of the acquisition of
6666
the first volume.
6767

src/schema/objects/columns.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
HED:
33
name: HED
4-
display_name: HED Tag
4+
display_name: HED
55
description: |
6-
Hierarchical Event Descriptor (HED) Tag.
6+
Hierarchical Event Descriptor (HED) tags.
77
See the [HED Appendix](SPEC_ROOT/appendices/hed.md) for details.
88
type: string
99
abbreviation:
@@ -582,7 +582,7 @@ stim_file:
582582
Represents the location of the stimulus file (such as an image, video, or
583583
audio file) presented at the given onset time.
584584
There are no restrictions on the file formats of the stimuli files,
585-
but they should be stored in the `/stimuli` directory
585+
but they should be stored in the `/stimuli/` directory
586586
(under the root directory of the dataset; with optional subdirectories).
587587
The values under the `stim_file` column correspond to a path relative to
588588
`/stimuli`.

0 commit comments

Comments
 (0)