You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/concepts.md
+16-16Lines changed: 16 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -53,7 +53,7 @@ Over the past few years, several labs have developed DataJoint-based data manage
53
53
54
54
## Element Architecture
55
55
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.
Tables related to the Neuropixels probe and electrode configuration.
75
75
76
76
| Table | Description |
77
77
| --- | --- |
78
78
| 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. |
Tables related to information about physiological recordings and automatic ingestion of spike sorting results.
86
86
87
87
| Table | Description |
88
88
| --- | --- |
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. |
96
96
97
97
## Element Development
98
98
@@ -113,12 +113,12 @@ Major features of the Array Electrophysiology Element include:
113
113
+ Triggering support for workflow integrated Kilosort processing.
114
114
+ Sample data and complete test suite for quality assurance.
115
115
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
-
118
116
## Data Export and Publishing
119
117
120
118
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/).
121
119
122
120
## Roadmap
123
121
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
+
124
124
Further development of this Element is community driven. Upon user requests we will continue adding features to this Element.
Copy file name to clipboardExpand all lines: docs/src/index.md
+7-1Lines changed: 7 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,13 @@
2
2
3
3
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.
4
4
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).
0 commit comments