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

naming and documentation for perievent #373

Open
samdeoxys1 opened this issue Nov 25, 2024 · 0 comments
Open

naming and documentation for perievent #373

samdeoxys1 opened this issue Nov 25, 2024 · 0 comments

Comments

@samdeoxys1
Copy link

I find the user guide for perievent a bit confusing. It would be helpful for me if the documentation more explicitly points out which argument serves which role in the functions and example data types for that argument.
For instance, 'data' is the variable to be grouped and counted (Ts), and 'tref' are the events to which the data histograms are aligned (Ts). Example data - tref pairs are: 'spike' - 'stimulus', or 'stimulus' - 'spike' (for the continuous case).
The above is just a rough idea, but the main point is to give a more direct guidance on how to fill in the function without too much guessing and reasoning.

'The object perievent is now of shape (number of bins, (dimensions of input), number of events )'
I found it to be (number of bins, number of events, dimensions of data)?

I'm also curious why compute_event_trigger_average just completely switched the argument names, compared to the compute_perievent and compute_perievent_continuous. It would make sense to me if they share the same argument names?

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

No branches or pull requests

1 participant