Skip to content
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

[ENH] Define channel column for events and Delimiter field for column descriptions #1483

Merged
merged 7 commits into from
Nov 13, 2023
Merged

[ENH] Define channel column for events and Delimiter field for column descriptions #1483

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a3e3d25
ENH: Define a channel column for events
effigies May 2, 2023
ab0e6a9
ENH: Define a Delimiter field for column descriptions
effigies May 2, 2023
df07a15
be clear that not the column is a list of values, but each row in tha…
sappelhoff Oct 26, 2023
8a88eaf
extend example in events spec to include delimiters
sappelhoff Oct 26, 2023
e64314b
use HED in example
sappelhoff Nov 6, 2023
d1056c1
Update src/schema/objects/columns.yaml
sappelhoff Nov 6, 2023
2a12171
Update src/modality-specific-files/task-events.md
sappelhoff Nov 13, 2023
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
23 changes: 15 additions & 8 deletions src/modality-specific-files/task-events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,10 @@ A guide for using macros can be found at
Example of the content of the TSV file:

```Text
onset duration trial_type response_time stim_file channel artifact
onset duration trial_type response_time stim_file channel annots
1.23 0.65 start 1.435 images/red_square.jpg n/a n/a
5.65 0.65 stop 1.739 images/blue_square.jpg n/a n/a
12.1 2.35 n/a n/a n/a F,1|F,2|Cz sweat
12.1 2.35 n/a n/a n/a F,1|F,2|Cz musc
```

In the accompanying JSON sidecar, the `trial_type` column might look as follows:
Expand All @@ -104,8 +104,15 @@ In the accompanying JSON sidecar, the `trial_type` column might look as follows:
"Description": "Channel(s) associated with the event",
"Delimiter": "|"
},
"artifact": {
"Description": "Description of an artifact."
"annots": {
"LongName": "Annotations",
"Description": "Hierarchical Event Descriptors (HED) annotations",
sappelhoff marked this conversation as resolved.
Show resolved Hide resolved
"Levels": {
"musc": "Muscle artifact. A very common, high frequency, sharp artifact that corresponds with agitation/nervousness in a patient."
},
"HED": {
"musc": "EMG-artifact"
}
}
}
```
Expand All @@ -116,17 +123,17 @@ Note that in the example above:
In a real dataset, all other columns SHOULD also be described.

1. The `channel` column contains a list of values that are separated
VisLab marked this conversation as resolved.
Show resolved Hide resolved
by a non-default delimiter (that is, *not* with a comma `,`).
See the `Delimiter` field in the accompanying JSON sidecar.
by a delimiter (`|`), as is declared in the `Delimiter` metadata
field of the `events.json file.
Thus, the channels related to the event in the third row of the example
are called `F,1`, `F,2`, and `Cz`.

1. The example contains a column called `artifact`.
1. The example contains a column called `annots`.
This column is not defined in BIDS, and constitutes additional, arbitrary
(that is, unofficial) metadata.
In the present case, it is used to describe artifacts in the data,
sappelhoff marked this conversation as resolved.
Show resolved Hide resolved
in reference to the `channel` column.
Note that in practice, such a hypothetical `artifact` column should make
The `annots` column is making
use of the powerful HED system for documenting events, see below.

Events MAY also be documented in machine-actionable form
Expand Down