Spike Unit Annotation

[samuelbray32]

Description

Resolves #1012

• makes standard unit_id = "{spikesorting_merge_id}_{unit_number}" for linking units across analyses
• Add option return_unit_ids to fetch_spike_data in:
  • SortedSpikesGroup
  • SortedSpikesDecodingV1
• Implement new spikesorting analysis table UnitAnnotation and part table Annotation
  • Designed to allow users to query intersect of labels across analyses
  • Allows users to fetch subset of units based on annotation restriction
• Add new tutorial notebook 11_Spike_Sorting_Analysis containing SortedSpikesGroup and UnitAnnotation tutorials

Checklist:

• no This PR should be accompanied by a release: (yes/no/unsure)
• n/a If release, I have updated the CITATION.cff
• no This PR makes edits to table definitions: (yes/no)
• n/a If table edits, I have included an alter snippet for release notes.
• n/a If this PR makes changes to position, I ran the relevant tests locally.
• I have updated the CHANGELOG.md with PR number and description.
• I have added/edited docs/notebooks to reflect the changes

[samuelbray32]

Draft Note:

The UnitAnnotation table might want more feedback. That said, I think the return_unit_ids feature would be useful (at least to me) on it's own, and I would be fine reducing the PR to just that

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[edeno]

1. What's the difference between a label and a quantification? Is that explained in the tutorial notebook anywhere?
2. I think the notebook needs to be added to the docs

[samuelbray32]

What's the difference between a label and a quantification? Is that explained in the tutorial notebook anywhere?

A label would be a string identifieer (e.g. {"annotation":"cell_type", "label":"pyridimal cell"}) whereas a quantification is a float number (e.g. {"annotation":"firing_rate", "quantification": 6.3})

I'll make sure the notebook includes example of both

[CBroz1]

Hi @samuelbray32. Thanks for these adds. I have a systematic suggestion in here about avoiding string concatenation.

Related to docs ...

1. Please make mention of the new notebook in ...
   • notebooks/README.md
   • docs/mkdocs.yml
2. Please try serving the mkdocs to check the docstrings of new tables - the stdout will report formatting issues when it builds api.

[edeno]

Just a minor spelling error fix.