Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docstrings to SortedSpikesGroup and Decoding methods #996

Merged
merged 3 commits into from
Jun 4, 2024

Conversation

samuelbray32
Copy link
Collaborator

@samuelbray32 samuelbray32 commented Jun 4, 2024

Description

Adds docstrings to methods in SortedSpikesGroup ClusterlessDecodingV1 and SortedSpikesDecodingV1

Checklist:

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

@samuelbray32 samuelbray32 requested a review from edeno June 4, 2024 21:55
@edeno edeno merged commit 6b49c2d into master Jun 4, 2024
7 checks passed
@edeno edeno deleted the spike_decode_doc branch June 4, 2024 22:06
edeno pushed a commit that referenced this pull request Jun 18, 2024
* Give UUID to artifact interval

* Add ability to set smoothing sigma in get_firing_rate (#994)

* add option to set spike smoothing sigma

* update changelog

* Add docstrings to SortedSpikesGroup and Decoding methods (#996)

* Add docstrings

* update changelog

* fix spelling

---------

Co-authored-by: Samuel Bray <[email protected]>

* Add Common Errors doc (#997)

* Add Common Errors

* Update changelog

* Mua notebook (#998)

* documented some of mua notebook

* mua notebook documented

* documented some of mua notebook

* synced py script

* Dandi export and read (#956)

* compile exported files, download dandiset, and organize

* add function to translate files into dandi-compatible names

* add table to store dandi name translation and steps to populate

* add dandiset validation

* add function to fetch nwb from dandi

* add function to change obj_id of nwb_file

* add dandi upload call and fix circular import

* debug dandi file streaming

* fix circular import

* resolve dandi-streamed files with fetch_nwb

* implement review comments

* add admin tools to fix common dandi discrepencies

* implement tool to cleanup common dandi errors

* add dandi export to tutorial

* fix linting

* update changelog

* fix spelling

* style changes from review

* reorganize function locations

* fix circular import

* make dandi dependency optional in imports

* store dandi instance of data in DandiPath

* resolve case of pre-existing dandi entries for export

* cleanup bugs from refactor

* update notebook

* Apply suggestions from code review

Co-authored-by: Chris Broz <[email protected]>

* add requested changes from review

* make method check_admin_privilege in LabMember

---------

Co-authored-by: Chris Broz <[email protected]>

* Minor fixes (#999)

* give analysis nwb new uuid when created

* fix function argument

* update changelog

* Fix bug in change in analysis_file object_id (#1004)

* fix bug in change in analysis_file_object_id

* update changelog

* Remove classes for usused tables (#1003)

* #976

* Remove notebook reference

* Non-daemon parallel populate (#1001)

* initial non daemon parallel commit

* resolve namespace and pickling errors

* fix linting

* update changelog

* implement review comments

* add parallel_make flag to spikesorting recording tables

* fix multiprocessing spawn error on mac

* move propert

---------

Co-authored-by: Samuel Bray <[email protected]>

* Update pipeline column for IntervalList

---------

Co-authored-by: Samuel Bray <[email protected]>
Co-authored-by: Samuel Bray <[email protected]>
Co-authored-by: Chris Broz <[email protected]>
Co-authored-by: Denisse Morales-Rodriguez <[email protected]>
Co-authored-by: Samuel Bray <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants