search

NeuralEnsemble / elephant

Elephant is the Electrophysiology Analysis Toolkit
http://www.python-elephant.org
BSD 3-Clause "New" or "Revised" License
195 stars 92 forks source link

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

Open mdenker opened 2 years ago

mdenker commented 2 years ago

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 commented 2 years ago

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

kohlerca commented 1 year ago

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).