-
Notifications
You must be signed in to change notification settings - Fork 96
Trial handling: additional functionality and documentation #673
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
base: master
Are you sure you want to change the base?
Conversation
…piketrain across trials
…s.py to trials.py. GPFA methods and unit tests adjusted.
…s are accessed by indexes (instead of ambiguous terms ID or number). Added deprecations with warning decorator and corresponding unit tests.
…specific value checks
| individual data of each trial. | ||
|
|
||
| The classes of this module abstract from these specific data representations | ||
| by introducing a set of :class:`Trials` classes with a common API. These |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While working on instantaneous_rate fix PR #649 , I noticed that sphinx doesn't create a link for :class:Trials . Further check on RTD seems to reveal there is no page for this base class? dedicated pages only exist for the subclasses (e.g. TrailsFromBlocks etc..).
Should we leave this as is, add a page for the base class, or link to the existing Trials documentation wherever a reference is needed(e.g. in statistics.py etc..)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One fix i tried out is using the :mod: cross referencing, so this takes us to the right module page. So for trials one lands on the trials page, from there TrailsFromBlocks or the other one can be selected.
This PR is a revision of the existing
Trialsobjects. Several improvements are implemented:Functionality
get_spiketrains_trial_by_trialandget_analogsignals_trial_by_trial).Trials, for improved maintenance.trial_index), instead of the previoustrial_idortrial_number.Documentation
TrialsFromBlockandTrialsFromList.TODOs