Skip to content

Commit 633def8

Browse files
Reformat & remove redundancy
Updated headings and removed redundant description of "generic" Physiotype
1 parent 728602e commit 633def8

1 file changed

Lines changed: 9 additions & 19 deletions

File tree

src/modality-specific-files/physiological-recordings.md

Lines changed: 9 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -416,7 +416,7 @@ A guide for using macros can be found at
416416
},
417417
}) }}
418418

419-
## Physiology "events"
419+
### Physiology "events"
420420

421421
Discontinuous data associated with continuous recordings
422422
stored in `<matches>_physio.tsv.gz` files MAY be specified
@@ -555,13 +555,9 @@ the `OnsetSource` is set to `"n/a"` in `sub-01_task-nback_physioevents.json`:
555555

556556
<!-- #!# This needs to be fixed -->
557557

558-
### 2. JSON Data files
558+
**JSON Data files**. All metadata we are proposing are either **OPTIONAL** or **RECOMMENDED**, and they are meant to enrich the current `"generic"` `PhysioType`. However, we are also suggesting the introduction of a `"enriched"` `PhysioType`, that will differ from `"generic"` because one proposed metadata, `MeasureType`, will be **REQUIRED** rather than **RECOMMENDED**. Equally, the `Units` metadata will be **REQUIRED** instead of **RECOMMENDED** in this case.
559559

560-
Metadata sidecar files (`<matches>_physio.json`) **SHOULD** define the field `PhysioType`. This field indicates a specific type of formatting, rather than a physiological modality. The `PhysioType` `"generic"` value, being the default, **MUST** be assumed if the `PhysioType` metadata is not defined.
561-
562-
All metadata we are proposing are either **OPTIONAL** or **RECOMMENDED**, and they are meant to enrich the current `"generic"` `PhysioType`. However, we are also suggesting the introduction of a `"enriched"` `PhysioType`, that will differ from `"generic"` because one proposed metadata, `MeasureType`, will be **REQUIRED** rather than **RECOMMENDED**. Equally, the `Units` metadata will be **REQUIRED** instead of **RECOMMENDED** in this case.
563-
564-
Compared to the current BIDS specification (1.10.0), at the file level we are adding one metadata, the **OPTIONAL** `SubjectPosition`, indicating the position of the subject during the data collection (see section 2.1).
560+
Compared to the current BIDS specification (1.10.0), at the file level we are adding one metadata, the **OPTIONAL** `SubjectPosition`, indicating the position of the subject during the data collection (see below "Metadata fields used in top level metadata").
565561

566562
When specifying column names, columns **MUST** have unique names. All such data columns **MUST** be appropriately defined in the JSON metadata.
567563

@@ -573,39 +569,33 @@ When specifying column names, columns **MUST** have unique names. All such data
573569
"SamplingFrequency": 1000,
574570
"SubjectPosition": "sitting",
575571
"PhysioType": "enriched",
576-
...
577572
"screda1": {
578573
"MeasureType": "EDA-phasic",
579574
"Units": "mS",
580575
"Placement": "Thenar",
581-
...
582576
},
583577
"screda2": {
584578
"MeasureType": "EDA-tonic",
585579
"Units": "mS",
586580
"Placement": "Hypothenar",
587-
...
588581
},
589582
"ecg": {
590583
"MeasureType": "ECG",
591584
"Units": "mV",
592585
"Placement": "II",
593-
...
594586
},
595587
"ppg": {
596588
"MeasureType": "PPG",
597589
"Units": "au",
598590
"Placement": "Right earlobe",
599-
...
600-
},
601-
...
591+
}
602592
}
603593
```
604594

605-
As described in the following table (Section 2.2), this BEP is adding a few metadata to describe columns.
595+
As described in the table below ("Metadata fields for column description."), this BEP is adding a few metadata to describe columns.
606596

607597
- The most important one is `MeasureType`, a **RECOMMENDED** metadata that indicates the actual nature of the data in the column.
608-
- This metadata value is a string that **MUST** come from a set of keywords (see table 2.2).
598+
- This metadata value is a string that **MUST** come from a set of keywords.
609599
- This set of keywords can be expanded in the future to include more physiological modalities.
610600
- When the file-level metadata `PhysioType` is `"enriched"`, `MeasureType` becomes a **REQUIRED** field for each column.
611601

@@ -635,15 +625,15 @@ More information about the metadata entities contained in the JSON files can be
635625

636626
---
637627

638-
### 2.1 Metadata fields used in top level metadata
628+
**Metadata fields used in top level metadata.**
639629

640630
{{ MACROS___make_sidecar_table(["continuous.Continuous"]) }}
641631

642-
### 2.2 Metadata fields for column description
632+
**Metadata fields for column description.**
643633

644634
{{ MACROS___make_columns_table("physio.PhysioColumns") }}
645635

646-
### 2.3 MeasureType descriptions
636+
**MeasureType descriptions.**
647637

648638
| **MeasureType** | **Name** | **Description** |
649639
|-----------------|----------|-----------------|

0 commit comments

Comments
 (0)