Skip to content

Commit 73976f1

Browse files
committed
A pass to harmonize to use "microephys" in favor over "ephys"
Also used appropriate suffix in a few spots when encountered
1 parent 50a38db commit 73976f1

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

src/modality-specific-files/microelectrode-electrophysiology.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The current list of allowed data file formats:
2727
<!-- We should define icephys and ecephys -->
2828
| **Format** | **Extension(s)** | **Description** |
2929
|-------------------------------------------------------------------------------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
30-
| [Neuroscience Information Exchange Format](https://nixio.readthedocs.io/en/latest/) | `.nix` | A generic and open framework with an hdf5 backend and a defined interface to many ephys formats via the [Neo library](https://neo.readthedocs.io/en/latest/). The `.nix` file has to contain a valid Neo structure. |
30+
| [Neuroscience Information Exchange Format](https://nixio.readthedocs.io/en/latest/) | `.nix` | A generic and open framework with an hdf5 backend and a defined interface to many microephys formats via the [Neo library](https://neo.readthedocs.io/en/latest/). The `.nix` file has to contain a valid Neo structure. |
3131
| [Neurodata Without Borders](https://www.nwb.org) | `.nwb` | An open data standard for neurophysiology, including data from intracellular and extracellular electrophysiology experiments. |
3232

3333
Both of these formats can also store essential metadata of the datasets.
@@ -92,7 +92,7 @@ The coordinate system can be defined using reference pictures, anatomical landma
9292
For more details, see the [BIDS Coordinate Systems specifications](../appendices/coordinate-systems.md).
9393

9494

95-
Fields relating to the ephys probe and electrode positions:
95+
Fields relating to the microephys probe and electrode positions:
9696

9797
{{ MACROS___make_sidecar_table("microephys.microephysCoordsystemGeneral") }}
9898

@@ -296,13 +296,13 @@ For the `type` column we recommend to use the following terms (adopted from [iEE
296296
| **OTHER** | Any other type of channel |
297297

298298

299-
## General ephys metadata (*_ephys.json)
299+
## General microephys metadata (*_{i,e}cephys.json)
300300

301301
We propose to store all metadata that is not directly related to one of the other metadata files (probe/electrode/channel information) into a single JSON file: `_ephys.json`.
302302

303303
There should be one such JSON file for each data file.
304304

305-
The `*_ephys.json` file can be used to store any ephys-specific metadata for the dataset. We recommend storing all setup-related metadata in a dedicated node of the JSON file called `Setup`.
305+
The `*_ephys.json` file can be used to store any microephys-specific metadata for the dataset. We recommend storing all setup-related metadata in a dedicated node of the JSON file called `Setup`.
306306
We recommend using the following keys to describe the setup:
307307

308308
### Data origin metadata
@@ -428,7 +428,7 @@ The `*_events.tsv` and corresponding `*_events.json` sidecar files are OPTIONAL
428428
indicate time points of recording events. Each task events file requires a corresponding task data
429429
file. These events can be internal recording system events, task-related events, or events triggered
430430
by the experimentalist (for example, manual reward). Note that these events must share a common clock
431-
with the corresponding ephys recording data. For more details, see the
431+
with the corresponding microephys recording data. For more details, see the
432432
Task Events documentation.
433433
Note that this file can also be used to describe stimulation performed during the recording. For this,
434434
please follow the iEEG stimulation documentation.
@@ -513,7 +513,7 @@ On the first day it performed two tasks (nose-poke & rest), and on the second da
513513
rest task was performed.
514514
Detailed information about these tasks can be found in the `tasks.tsv` and `tasks.json` files.
515515
The electrophysiology data for each of the three recordings are stored in the corresponding
516-
session and ephys directories in the `nix` format. Metadata about the probes, their electrodes
516+
session and microephys directories in the `nix` format. Metadata about the probes, their electrodes
517517
and the corresponding recording channels are stored in `tsv` format. Note that in this case,
518518
this information is shared between data files (see BIDS Inheritance Principle): in the first session,
519519
the probe, electrode and channel files apply to both data files of that session, as they do not
@@ -529,21 +529,21 @@ contain a `task` entity in their name. For the nose-poke task, additional behavi
529529
"participants.tsv": "",
530530
"sub-A/": {
531531
"ses-20220101/": {
532-
"ephys/": {
533-
"sub-A_ses-20220101_task-nosepoke_ephys.nix": "",
534-
"sub-A_ses-20220101_task-nosepoke_ephys.json": "",
532+
"ecephys/": {
533+
"sub-A_ses-20220101_task-nosepoke_ecephys.nix": "",
534+
"sub-A_ses-20220101_task-nosepoke_ecephys.json": "",
535535
"sub-A_ses-20220101_task-nosepoke_events.tsv": "",
536-
"sub-A_ses-20220101_task-rest_ephys.nix": "",
537-
"sub-A_ses-20220101_task-rest_ephys.json": "",
536+
"sub-A_ses-20220101_task-rest_ecephys.nix": "",
537+
"sub-A_ses-20220101_task-rest_ecephys.json": "",
538538
"sub-A_ses-20220101_channels.tsv": "",
539539
"sub-A_ses-20220101_electrodes.tsv": "",
540540
"sub-A_ses-20220101_probes.tsv": ""
541541
}
542542
},
543543
"ses-20220102/": {
544-
"ephys/": {
545-
"sub-A_ses-20220102_task-rest_ephys.nix": "",
546-
"sub-A_ses-20220102_task-rest_ephys.json": "",
544+
"ecephys/": {
545+
"sub-A_ses-20220102_task-rest_ecephys.nix": "",
546+
"sub-A_ses-20220102_task-rest_ecephys.json": "",
547547
"sub-A_ses-20220102_channels.tsv": "",
548548
"sub-A_ses-20220102_electrodes.tsv": "",
549549
"sub-A_ses-20220102_probes.tsv": ""
@@ -558,7 +558,7 @@ contain a `task` entity in their name. For the nose-poke task, additional behavi
558558

559559
#### Intracellular Electrophysiology (Patch)
560560

561-
This dataset contains intracellular data from slices acquired from two subjects (20220101-A and 20220101B). Details about the subjects and the sample generation are documented in the samples (tsv/json) files. Data of each subject is stored in separate subject directories (top level directories), each of which contains an ‘ephys’ subdirectory. Note that there is no session-level directory in this case. Here, we choose the option of having “multiple tasks/runs in separate files” as described in 3.81., to demonstrate the high level of readability offered by the filenames in this case.
561+
This dataset contains intracellular data from slices acquired from two subjects (20220101-A and 20220101B). Details about the subjects and the sample generation are documented in the samples (tsv/json) files. Data of each subject is stored in separate subject directories (top level directories), each of which contains an ‘icephys/’ subdirectory. Note that there is no session-level directory in this case. Here, we choose the option of having “multiple tasks/runs in separate files” as described in 3.81., to demonstrate the high level of readability offered by the filenames in this case.
562562

563563
For the first subject only a single sample (a cell for patch-clamp terminology) was extracted (sample-cell001), on which two recordings (runs 1 and 2) were performed. Here, the `scans.tsv` file can be used to store information such as the starting recording times. The detailed information on the recording channel (such as the recording mode used) is stored in the `channels.tsv` which, in this case, is common to all available recordings. The probes and electrodes files provide information on the pipette and solutions used for the recordings and are also shared for the two data files.
564564

@@ -574,31 +574,31 @@ For the second subject two samples (sample-cell003 and sample-cell004) were extr
574574
"dataset_description.json": "",
575575
"sub-20220101A/": {
576576
"sub-20220101A_sample-cell001_scans.tsv": "",
577-
"ephys/": {
578-
"sub-20220101A_sample-cell001_run-1_ephys.nwb": "",
577+
"icephys/": {
578+
"sub-20220101A_sample-cell001_run-1_icephys.nwb": "",
579579
"sub-20220101A_sample-cell001_run-1_events.tsv": "",
580-
"sub-20220101A_sample-cell001_run-2_ephys.nwb": "",
580+
"sub-20220101A_sample-cell001_run-2_icephys.nwb": "",
581581
"sub-20220101A_sample-cell001_run-2_events.tsv": "",
582582
"sub-20220101A_channels.tsv": "",
583583
"sub-20220101A_electrodes.tsv": "",
584584
"sub-20220101A_probes.tsv": "",
585-
"sub-20220101A_ephys.json": "",
585+
"sub-20220101A_icephys.json": "",
586586
"sub-20220101A_events.json": ""
587587
}
588588
},
589589
"sub-20220101B/": {
590590
"sub-20220101B_sample-cell001_scans.tsv": "",
591-
"ephys/": {
592-
"sub-20220101B_sample-cell002_ephys.nwb": "",
591+
"icephys/": {
592+
"sub-20220101B_sample-cell002_icephys.nwb": "",
593593
"sub-20220101B_sample-cell002_events.tsv": "",
594594
"sub-20220101B_sample-cell002_channels.tsv": "",
595595
"sub-20220101B_sample-cell002_electrodes.tsv": "",
596-
"sub-20220101B_sample-cell003_ephys.nwb": "",
596+
"sub-20220101B_sample-cell003_icephys.nwb": "",
597597
"sub-20220101B_sample-cell003_events.tsv": "",
598598
"sub-20220101B_sample-cell003_channels.tsv": "",
599599
"sub-20220101B_sample-cell003_electrodes.tsv": "",
600600
"sub-20220101B_probes.tsv": "",
601-
"sub-20220101B_ephys.json": "",
601+
"sub-20220101B_icephys.json": "",
602602
"sub-20220101B_events.json": ""
603603
}
604604
}
@@ -614,7 +614,7 @@ This toy data set can be found in [this repository,](https://gin.g-node.org/Neur
614614

615615
Multiple datasets have been converted to follow this BEP proposal. These datasets typically have pruned data files to reduce the data file size, but are accompanied by the full set of metadata. A current version of these datasets can be found on GIN: [https://gin.g-node.org/NeuralEnsemble/BEP032-examples](https://gin.g-node.org/NeuralEnsemble/BEP032-examples)
616616

617-
For a complete dataset including all data samples the ephys dataset published in [Brochier (2018)](https://doi.org/10.1038/sdata.2018.55) has been reorganized according to the current version of this BEP, using the NIX data format. The up-to-date version of the dataset can be found here:
617+
For a complete dataset including all data samples the extracellular microelectrode dataset published in [Brochier (2018)](https://doi.org/10.1038/sdata.2018.55) has been reorganized according to the current version of this BEP, using the NIX data format. The up-to-date version of the dataset can be found here:
618618

619619
[https://gin.g-node.org/sprenger/multielectrode_grasp/src/bep_animalephys](https://gin.g-node.org/sprenger/multielectrode_grasp/src/bep_animalephys)
620620

0 commit comments

Comments
 (0)