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

[Doc] Documentation of SPADE module requires more details #439

Open
mdenker opened this issue Nov 26, 2021 · 2 comments
Open

[Doc] Documentation of SPADE module requires more details #439

mdenker opened this issue Nov 26, 2021 · 2 comments
Labels
bug Indicates an unexpected problem or unintended behavior documentation Indicates a need for improvements or additions to documentation

Comments

@mdenker
Copy link
Member

mdenker commented Nov 26, 2021

Describe the bug
The SPADE documentation requires more details on how to run the SPADE analysis, in particular the pattern filtering functions. Given the speed-optimized SPADE code, these should then also enter the corresponding tutorial.

@mdenker mdenker added bug Indicates an unexpected problem or unintended behavior documentation Indicates a need for improvements or additions to documentation labels Nov 26, 2021
@mdenker
Copy link
Member Author

mdenker commented Nov 26, 2021

@stellalessandra Would you be willing to help out in improvements to the docs for SPADE?

@Moritz-Alexander-Kern Moritz-Alexander-Kern added this to the v0.12.0 milestone Mar 31, 2022
@Moritz-Alexander-Kern Moritz-Alexander-Kern removed this from the v0.13.0 milestone Apr 24, 2023
@kohlerca
Copy link
Collaborator

Regarding this topic, the description of the outputs also needs better clarification in the docs.

For instance, the output dictionary is complex, with elements that will be present depending on the parameters. The documentation of spade function refers to the output of concept_output_to_patterns in one case.

However, the documentation of the latter seems to be wrong with respect to the actual output. Namely, it mentions that the lags element is "lags (integers corresponding to the number of bins) between the spikes of the patterns. Actually, Quantity arrays are returned (floats with time units), and the entry in lags is the time of the bin with respect to the time in times list, i.e., the time lag with respect to the start of the pattern, not between the spikes (and not a bin number).

@Moritz-Alexander-Kern Moritz-Alexander-Kern changed the title [Bug] Documentation of SPADE module requires more details [Doc] Documentation of SPADE module requires more details Mar 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Indicates an unexpected problem or unintended behavior documentation Indicates a need for improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants