Skip to content

Commit c75e2d7

Browse files
committed
Changes applied from code review
1 parent 37d6a60 commit c75e2d7

File tree

2 files changed

+23
-17
lines changed

2 files changed

+23
-17
lines changed

docs/src/concepts.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Over the past few years, several labs have developed DataJoint-based data manage
5353

5454
## Element Architecture
5555

56-
Each of the DataJoint Elements are a set of tables for common neuroinformatics modalities to organize, preprocess, and analyze data. Each node in the following diagram is either a table in the Element itself or a table that would be connected to the Element.
56+
Each of the DataJoint Elements creates a set of tables for common neuroscience data modalities to organize, preprocess, and analyze data. Each node in the following diagram is a table within the Element or a table connected to the Element.
5757

5858
![element-array-ephys diagram](https://raw.githubusercontent.com/datajoint/element-array-ephys/main/images/attached_array_ephys_element_acute.svg)
5959

@@ -62,37 +62,37 @@ Each of the DataJoint Elements are a set of tables for common neuroinformatics m
6262

6363
| Table | Description |
6464
| --- | --- |
65-
| Subject | Basic information of the research subject |
65+
| Subject | Basic information of the research subject. |
6666

6767
### `session` schema ([API docs](https://datajoint.com/docs/elements/element-session/api/element_session/session_with_datetime))
6868

6969
| Table | Description |
7070
| --- | --- |
71-
| Session | Unique experimental session identifier |
71+
| Session | Unique experimental session identifier. |
7272

7373
### `probe` schema ([API docs](../api/element_array_ephys/probe))
7474
Tables related to the Neuropixels probe and electrode configuration.
7575

7676
| Table | Description |
7777
| --- | --- |
7878
| ProbeType | a lookup table specifying the type of Neuropixels probe (e.g. "neuropixels 1.0", "neuropixels 2.0 single-shank"). |
79-
| ProbeType.Electrode | all electrodes and their properties for a particular probe type. |
80-
| Probe | record of an actual physical probe, identifiable by some unique ID (e.g. probe's serial number). |
81-
| ElectrodeConfig | particular electrode configuration to be used for ephys recording. |
82-
| ElectrodeConfig.Electrode | corresponding electrodes in `ProbeType.Electrode` that are used for recording in this electrode configuration (e.g. for Neuropixels 1.0 or 2.0, there can be at most 384 electrodes usable for recording per probe). |
79+
| ProbeType.Electrode | a table containing electrodes and their properties for a particular probe type. |
80+
| Probe | a record of an actual physical probe. |
81+
| ElectrodeConfig | a record of a particular electrode configuration to be used for ephys recording. |
82+
| ElectrodeConfig.Electrode | a record of electrodes out of those in `ProbeType.Electrode` that are used for recording. |
8383

8484
### `ephys` schema ([API docs](../api/element_array_ephys/ephys))
8585
Tables related to information about physiological recordings and automatic ingestion of spike sorting results.
8686

8787
| Table | Description |
8888
| --- | --- |
89-
| ProbeInsertion | A surgical insertion of a probe in the brain. Every experimental session consists of one or more entries in `ProbeInsertion` with a corresponding `InsertionLocation` each. |
90-
| EphysRecording | each `ProbeInsertion` is accompanied by a corresponding `EphysRecording`, specifying the `ElectrodeConfig` used for the recording from the `Probe` defined in `ProbeInsertion`. |
91-
| Clustering | specify instance(s) of clustering on an `EphysRecording`, by some `ClusteringMethod`. |
92-
| Curation | specify instance(s) of curations performed on the output of a given `Clustering`. |
93-
| CuratedClustering | set of results from a particular round of clustering/curation. |
94-
| CuratedClusting.Unit | Identified unit(s) from one `Curation`, and the associated properties (e.g. cluster quality, spike times, spike depths, etc.). |
95-
| WaveformSet | A set of spike waveforms for units from a given `CuratedClustering`. |
89+
| ProbeInsertion | a record of surgical insertions of a probe in the brain. |
90+
| EphysRecording | a table with metadata about each electrophysiogical recording. |
91+
| Clustering | a table with clustering data for spike sorting extracellular electrophysiology data. |
92+
| Curation | a table to declare optional manual curation of spike sorting results. |
93+
| CuratedClustering | a table with metadata for sorted data generated after each curation. |
94+
| CuratedClusting.Unit | a part table containing single unit information after spike sorting and optional curation. |
95+
| WaveformSet | a table containing spike waveforms for single units. |
9696

9797
## Element Development
9898

@@ -113,12 +113,12 @@ Major features of the Array Electrophysiology Element include:
113113
+ Triggering support for workflow integrated Kilosort processing.
114114
+ Sample data and complete test suite for quality assurance.
115115

116-
Incorporation of SpikeInterface into the Array Electrophysiology Element will be on DataJoint Elements development roadmap. Dr. Loren Frank has led a development effort of a DataJoint pipeline with SpikeInterface framework and NeurodataWithoutBorders format integrated (https://github.com/LorenFrankLab/nwb_datajoint).
117-
118116
## Data Export and Publishing
119117

120118
Element Array Electrophysiology supports exporting of all data into standard Neurodata Without Borders (NWB) files. This makes it easy to share files with collaborators and publish results on [DANDI Archive](https://dandiarchive.org/). [NWB](https://www.nwb.org/), as an organization, is dedicated to standardizing data formats and maximizing interoperability across tools for neurophysiology. For more information on uploading NWB files to DANDI within the DataJoint Elements ecosystem, visit our documentation for the DANDI upload feature of [Element Array Electrophysiology](datajoint.com/docs/elements/element-array-ephys/).
121119

122120
## Roadmap
123121

122+
Incorporation of SpikeInterface into the Array Electrophysiology Element will be on DataJoint Elements development roadmap. Dr. Loren Frank has led a development effort of a DataJoint pipeline with SpikeInterface framework and NeurodataWithoutBorders format integrated [https://github.com/LorenFrankLab/nwb_datajoint](https://github.com/LorenFrankLab/nwb_datajoint).
123+
124124
Further development of this Element is community driven. Upon user requests we will continue adding features to this Element.

docs/src/index.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,13 @@
22

33
This Element features DataJoint schemas for analyzing extracellular array electrophysiology data acquired with Neuropixels probes and spike sorted using Kilosort spike sorter. Each Element is a modular pipeline for data storage and processing with corresponding database tables that can be combined with other Elements to assemble a fully functional pipeline.
44

5-
The Element is comprised of `probe` and `ephys` schemas. There are several `ephys` schemas including `ephys_acute`, `ephys_chronic`, and `ephys_precluster` to handle several use cases of this pipeline and workflow. Visit the [Concepts page](./concepts.md) for more information about the use cases of `ephys` schemas and an explanation of the tables. To get started with building your own data pipeline, visit the [Tutorials page](./tutorials.md).
5+
The Element is comprised of `probe` and `ephys` schemas. Several `ephys` schemas are developed to handle various use cases of this pipeline and workflow:
6+
+ `ephys_acute`: A probe is inserted into a new location during each session.
7+
+ `ephys_chronic`: A probe is inserted once and used to record across multiple sessions.
8+
+ `ephys_precluster`: A probe is inserted into a new location during each session. Pre-clustering steps are performed on the data from each probe prior to Kilosort analysis.
9+
+ `ephys_no_curation`: A probe is inserted into a new location during each session and Kilosort-triggered clustering is performed without the option to manually curate the results.
10+
11+
Visit the [Concepts page](./concepts.md) for more information about the use cases of `ephys` schemas and an explanation of the tables. To get started with building your own data pipeline, visit the [Tutorials page](./tutorials.md).
612

713
### `ephys_acute` module
814
![element-array-ephys-acute diagram](https://raw.githubusercontent.com/datajoint/element-array-ephys/main/images/attached_array_ephys_element_acute.svg)

0 commit comments

Comments
 (0)