Skip to content
This repository was archived by the owner on Dec 8, 2023. It is now read-only.

Conversation

@JaerongA
Copy link
Collaborator

@JaerongA JaerongA commented Mar 22, 2023

  • Added quality_metrics.ipynb for visualizing qc metrics.
  • Added documentation for each metric.
  • Added pytest for ephys.QualityMetrics

@JaerongA JaerongA added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 22, 2023
Copy link
Collaborator

@kabilar kabilar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @JaerongA. Please make the following updates:

  • Plots for all metrics in ephys.QualityMetrics.Cluster.
  • Plots for all metrics in ephys.QualityMetrics.Waveform.
  • Add x- and y-axis ticks and labels with units.

@kushalbakshi
Copy link
Collaborator

kushalbakshi commented Apr 12, 2023

Hi @JaerongA, just a few small comments:

  • At the start of the notebook, can you please add the following:
This notebook is used to visualize the spike sorting quality metrics using the metrics.csv generated from kilosort. 

If you are new to using DataJoint for array electrophysiology - please see our [tutorial](./tutorial.ipynb) notebook for an in-depth explanation for setting up and running the DataJoint Workflow for NeuroPixels electrophysiology.

The Element also offers Quality Metric visualizations. These are generated using metrics.csv generated from kilosort.

@JaerongA JaerongA requested a review from kabilar April 13, 2023 15:58
@kabilar
Copy link
Collaborator

kabilar commented Apr 14, 2023

Please update version and changelog.

Co-authored-by: Kabilar Gunalan <kabilar@datajoint.com>
JaerongA and others added 2 commits April 14, 2023 16:17
Co-authored-by: Kabilar Gunalan <kabilar@datajoint.com>
@kabilar
Copy link
Collaborator

kabilar commented Apr 17, 2023

We are missing descriptions for the following metrics in the notebook:

  • Nearest Neighbor Miss Rate
  • Silhouette Score
  • Max Drift
  • Contamination Rate

@JaerongA
Copy link
Collaborator Author

We are missing descriptions for the following metrics in the notebook:

* [ ]  Nearest Neighbor Miss Rate

* [ ]  Silhouette Score

* [ ]  Max Drift

* [ ]  Contamination Rate

@kabilar I left some of these metrics blank because I couldn't find the information in the reference. Although some of them seem obvious, I didn't assume anything since the actual algorithm could be different. Can you provide me with a resource to fill in the gaps, if any?

@kabilar
Copy link
Collaborator

kabilar commented Apr 17, 2023

@kabilar I left some of these metrics blank because I couldn't find the information in the reference. Although some of them seem obvious, I didn't assume anything since the actual algorithm could be different. Can you provide me with a resource to fill in the gaps, if any?

Silhouette Score and Max Drift can be found here: https://elifesciences.org/articles/61834/figures#tables

@kabilar
Copy link
Collaborator

kabilar commented Apr 17, 2023

Thanks @JaerongA. To clarify, the last cluster metric plotted is Contamination Rate, not Cumulative Drift.

@JaerongA JaerongA requested a review from kabilar April 21, 2023 15:10
kabilar and others added 3 commits April 21, 2023 12:02
Co-authored-by: Kabilar Gunalan <kabilar@datajoint.com>
Co-authored-by: Kabilar Gunalan <kabilar@datajoint.com>
@JaerongA JaerongA requested a review from kabilar April 21, 2023 18:41
@kabilar
Copy link
Collaborator

kabilar commented Apr 21, 2023

Please add a description of Cumulative Drift.

@kabilar
Copy link
Collaborator

kabilar commented Apr 21, 2023

Could you please clarify the description for ISI violation.

ISI (Interspike interval) violation - Rate of ISI violation as a fraction of overall rate.

@kabilar
Copy link
Collaborator

kabilar commented Apr 21, 2023

@JaerongA I have submitted a few more suggestions to your fork/branch since it is currently difficult to provide suggestions on a Jupyter notebook: JaerongA#1

Copy link
Collaborator

@kabilar kabilar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @JaerongA! I have a few suggestions above.

Copy link
Collaborator

@kabilar kabilar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @JaerongA!

@kabilar kabilar merged commit e96b0cf into datajoint:main Apr 22, 2023
@kabilar
Copy link
Collaborator

kabilar commented Apr 22, 2023

Version 0.3.2 is tagged and released on GitHub.

@kabilar
Copy link
Collaborator

kabilar commented Apr 22, 2023

Docs have been released to render the quality metrics notebook on the website.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants