Skip to content

Commit

Permalink
label -> desc_id
Browse files Browse the repository at this point in the history
  • Loading branch information
sappelhoff committed Nov 8, 2023
1 parent 5ab8b1e commit fede5d3
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/derivatives/common-data-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -259,17 +259,17 @@ static volume, a `RepetitionTime` property would no longer be relevant).
To keep a record of processing steps applied to the data, a `descriptions.tsv` file MAY be used.
The `descriptions.tsv` file MUST contain at least the following two columns:

- `label`
- `desc_id`
- `description`

This file MAY be located at the root of the derivative dataset,
or at the subject or session level
([Inheritance Principle](../common-principles.md#the-inheritance-principle)).

The `label` column contains the labels used with the [`desc entity`](../appendices/entities.md#desc),
The `desc_id` column contains the labels used with the [`desc entity`](../appendices/entities.md#desc),
within the particular nesting that the `descriptions.tsv` file is placed.
For example, if the `descriptions.tsv` file is placed at the root of the derivative dataset,
its `label` column SHOULD contain all labels of the [`desc entity`](../appendices/entities.md#desc)
its `desc_id` column SHOULD contain all labels of the [`desc entity`](../appendices/entities.md#desc)
used across the entire derivative dataset.

The `description` column contains human-readable descriptions of the processing steps.
Expand Down Expand Up @@ -319,7 +319,7 @@ A guide for using macros can be found at

Contents of the `descriptions.tsv` file:

| label | description |
| desc_id | description |
|---------|-------------------------------------------------------------------------------------------------|
| Filt | low-pass filtered at 30Hz |
| FiltDs | low-pass filtered at 30Hz, downsampled to 250Hz |
Expand Down

0 comments on commit fede5d3

Please sign in to comment.