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.

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

[MISC] minor wording and consistency improvements for channels.tsv in EEG, MEG, iEEG #993

Merged
merged 1 commit into from
Feb 1, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 7 additions & 8 deletions src/04-modality-specific-files/02-magnetoencephalography.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,14 +218,13 @@ Date time information MUST be expressed as indicated in [Units](../02-common-pri

{{ MACROS___make_filename_template(datatypes=["meg"], suffixes=["channels"]) }}

This file is RECOMMENDED as it provides easily searchable information across
BIDS datasets for example, general curation, response to queries or batch
analysis.
To avoid confusion, the channels SHOULD be listed in the order they
appear in the MEG data file.
Missing values MUST be indicated with `n/a`.

The columns of the Channels description table stored in `*_channels.tsv` are:
This file is RECOMMENDED as it provides easily searchable information across BIDS datasets.
For example for general curation, response to queries, or for batch analysis.
To avoid confusion, the channels SHOULD be listed in the order they appear in the MEG data file.
Any number of additional columns MAY be added to provide additional information about the channels.
Missing values MUST be indicated with `"n/a"`.

The columns of the channels description table stored in `*_channels.tsv` are:

MUST be present **in this specific order**:

Expand Down
18 changes: 8 additions & 10 deletions src/04-modality-specific-files/03-electroencephalography.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,23 +184,21 @@ Date time information MUST be expressed as indicated in [Units](../02-common-pri

{{ MACROS___make_filename_template(datatypes=["eeg"], suffixes=["channels"]) }}

This file is RECOMMENDED as it provides easily searchable information across
BIDS datasets for example, general curation, response to queries or batch
analysis.
To avoid confusion, the channels SHOULD be listed in the order they
appear in the EEG data file.
Any number of additional columns may be added to provide additional information
about the channels.

Note that electrode positions SHOULD NOT be added to this file, but to [`*_electrodes.tsv`](./03-electroencephalography.md#electrodes-description-_electrodestsv).
This file is RECOMMENDED as it provides easily searchable information across BIDS datasets.
For example for general curation, response to queries, or for batch analysis.
To avoid confusion, the channels SHOULD be listed in the order they appear in the EEG data file.
Any number of additional columns MAY be added to provide additional information about the channels.

Note that electrode positions SHOULD NOT be added to this file, but to
[`*_electrodes.tsv`](./03-electroencephalography.md#electrodes-description-_electrodestsv).
Furthermore, the entries in `*_electrodes.tsv` and `*_channels.tsv` do not have to match exactly,
as for example in the case of recording a single `EOG` channel from a bipolar referencing scheme
of two electrodes, or a data channel originating from an auxiliary, non-electrode device.
That is, in most cases `*_electrodes.tsv` will have more entries than `*_channels.tsv`.
See the examples for `*_channels.tsv` below, and for `*_electrodes.tsv` in
["Electrodes description"](./03-electroencephalography.md#electrodes-description-_electrodestsv).

The columns of the Channels description table stored in `*_channels.tsv` are:
The columns of the channels description table stored in `*_channels.tsv` are:

MUST be present **in this specific order**:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -204,21 +204,17 @@ Date time information MUST be expressed as indicated in [Units](../02-common-pri

{{ MACROS___make_filename_template(datatypes=["ieeg"], suffixes=["channels"]) }}

A channel represents one time series recorded with the recording system (for
example, there can be a bipolar channel, recorded from two electrodes or contact
points on the tissue).
A channel represents one time series recorded with the recording system
(for example, there can be a bipolar channel, recorded from two electrodes or contact points on the tissue).
Although this information can often be extracted from the iEEG recording,
listing it in a simple `.tsv` document makes it easy to browse or search (for example,
searching for recordings with a sampling frequency of >=1000 Hz).
Hence, the channels.tsv is RECOMMENDED.
Channels SHOULD appear in the table in the same order they do in the iEEG data
file.
Any number of additional columns may be provided to provide additional
information about the channels.
Note that electrode positions SHOULD NOT be added to this file but to
`*_electrodes.tsv`.

The columns of the Channels description table stored in `*_channels.tsv` are:
listing it in a simple `.tsv` document makes it easy to browse or search
(for example, searching for recordings with a sampling frequency of >=1000 Hz).
Hence, the `channels.tsv` file is RECOMMENDED.
Channels SHOULD appear in the table in the same order they do in the iEEG data file.
Any number of additional columns MAY be provided to provide additional information about the channels.
Note that electrode positions SHOULD NOT be added to this file but to `*_electrodes.tsv`.

The columns of the channels description table stored in `*_channels.tsv` are:

MUST be present **in this specific order**:

Expand Down