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

[FIX] document required column order MEG, EEG, iEEG, PET, and fix typo iEEG #818

Merged
merged 2 commits into from
Jun 11, 2021
Merged

[FIX] document required column order MEG, EEG, iEEG, PET, and fix typo iEEG #818

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
78a8a66
fix: inconsistency in ieeg table and text
sappelhoff Jun 6, 2021
c1c3d89
PET: clarify that time column must be first in blood tsv
sappelhoff Jun 10, 2021
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
6 changes: 3 additions & 3 deletions src/04-modality-specific-files/02-magnetoencephalography.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ Missing values MUST be indicated with `n/a`.

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

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

| **Column name** | **Requirement level** | **Description** |
| --------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
Expand All @@ -221,8 +221,8 @@ SHOULD be present:
Example:

```Text
name type units description sampling_frequency low_cutoff high_cutoff notch software_filters status
UDIO001 TRIG V analogue trigger 1200 0.1 300 0 n/a good
name type units description sampling_frequency low_cutoff high_cutoff notch software_filters status
UDIO001 TRIG V analogue trigger 1200 0.1 300 0 n/a good
MLC11 MEGGRADAXIAL T sensor 1st-order grad 1200 0 n/a 50 SSS bad
```

Expand Down
6 changes: 2 additions & 4 deletions src/04-modality-specific-files/03-electroencephalography.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,8 +188,6 @@ Date time information MUST be expressed as indicated in [Units](../02-common-pri
This file is RECOMMENDED as it provides easily searchable information across
BIDS datasets for for example, general curation, response to queries or batch
analysis.
The required columns are channel `name`, `type` and `units` in this specific
order.
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
Expand All @@ -205,7 +203,7 @@ See the examples for `*_channels.tsv` below, and for `*_electrodes.tsv` in

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

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

| **Column name** | **Requirement level** | **Description** |
| --------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
Expand Down Expand Up @@ -277,7 +275,7 @@ expected in cartesian coordinates according to the `EEGCoordinateSystem` and
file MUST be specified as well**. The order of the required columns in the
`*_electrodes.tsv` file MUST be as listed below.

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

| **Column name** | **Requirement level** | **Description** |
| --------------- | --------------------- | ----------------------------------- |
Expand Down
7 changes: 3 additions & 4 deletions src/04-modality-specific-files/04-intracranial-electroencephalography.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,6 @@ 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.
The two required columns are channel `name` and `type`.
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
Expand All @@ -213,7 +212,7 @@ Note that electrode positions SHOULD NOT be added to this file but to

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

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

| **Column name** | **Requirement level** | **Description** |
| --------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
Expand Down Expand Up @@ -275,7 +274,7 @@ Note that upper-case is REQUIRED:

Example of free-form text for field `description`:

- intracranial, stimulus, response, vertical EOG, skin conductance
- intracranial, stimulus, response, vertical EOG, skin conductance

## Electrode description (`*_electrodes.tsv`)

Expand Down Expand Up @@ -315,7 +314,7 @@ For example:
The order of the required columns in the `*_electrodes.tsv` file MUST be as
listed below.

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

| **Column name** | **Requirement level** | **Description** |
| --------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
Expand Down
3 changes: 2 additions & 1 deletion src/04-modality-specific-files/09-positron-emission-tomography.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,8 @@ The following metadata SHOULD or MUST be provided if corresponding flags are `tr
| MetaboliteMethod | REQUIRED if `MetaboliteAvail` is `true` | [string][] | Method used to measure metabolites. |
| MetaboliteRecoveryCorrectionApplied | REQUIRED if `MetaboliteAvail` is `true` | [boolean][] | Metabolite recovery correction from the HPLC, for tracers where it changes with time postinjection. If `true`, the `hplc_recovery_fractions` column MUST be present in the corresponding `*_blood.tsv` file. |

The following columns are defined for `_blood.tsv` files:
The following columns are defined for `_blood.tsv` files.
The `time` column MUST always be the first column.

| **Column name** | **Requirement level** | **Description** | **Units** |
| ---------------------------- | ----------------------------------------------------------- | --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
Expand Down