Skip to content

Commit fc186dd

Browse files
ShiyuBelleWangsmoia
authored andcommitted
Reformat & remove redundancy
Updated headings and removed redundant description of "generic" Physiotype
1 parent 8388f01 commit fc186dd

File tree

1 file changed

+9
-19
lines changed

1 file changed

+9
-19
lines changed

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

Lines changed: 9 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -371,7 +371,7 @@ A guide for using macros can be found at
371371
},
372372
}) }}
373373

374-
## Physiology "events"
374+
### Physiology "events"
375375

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

511511
<!-- #!# This needs to be fixed -->
512512

513-
### 2. JSON Data files
514-
515-
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.
513+
**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.
516514

517-
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.
518-
519-
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).
515+
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").
520516

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

@@ -528,39 +524,33 @@ When specifying column names, columns **MUST** have unique names. All such data
528524
"SamplingFrequency": 1000,
529525
"SubjectPosition": "sitting",
530526
"PhysioType": "enriched",
531-
...
532527
"screda1": {
533528
"MeasureType": "EDA-phasic",
534529
"Units": "mS",
535530
"Placement": "Thenar",
536-
...
537531
},
538532
"screda2": {
539533
"MeasureType": "EDA-tonic",
540534
"Units": "mS",
541535
"Placement": "Hypothenar",
542-
...
543536
},
544537
"ecg": {
545538
"MeasureType": "ECG",
546539
"Units": "mV",
547540
"Placement": "II",
548-
...
549541
},
550542
"ppg": {
551543
"MeasureType": "PPG",
552544
"Units": "au",
553545
"Placement": "Right earlobe",
554-
...
555-
},
556-
...
546+
}
557547
}
558548
```
559549

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

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

@@ -590,15 +580,15 @@ More information about the metadata entities contained in the JSON files can be
590580

591581
---
592582

593-
### 2.1 Metadata fields used in top level metadata
583+
**Metadata fields used in top level metadata.**
594584

595585
{{ MACROS___make_sidecar_table(["continuous.Continuous"]) }}
596586

597-
### 2.2 Metadata fields for column description
587+
**Metadata fields for column description.**
598588

599589
{{ MACROS___make_columns_table("physio.PhysioColumns") }}
600590

601-
### 2.3 MeasureType descriptions
591+
**MeasureType descriptions.**
602592

603593
| **MeasureType** | **Name** | **Description** |
604594
|-----------------|----------|-----------------|

0 commit comments

Comments
 (0)