DynamicsAndNeuralSystems / pyspi

Comparative analysis of pairwise interactions in multivariate time series.
https://time-series-features.gitbook.io/pyspi/
GNU General Public License v3.0
198 stars 26 forks source link

Could you please provide more details about the config.ymal file? #37

Closed ChenK19 closed 7 months ago

ChenK19 commented 10 months ago

Hi, We are trying to analyse some neural time-series data, pyspi is a excellent job in my opinion. However we meet some problems for the unclear parts of the document, could you provide more illustration in documentation?

(1) For the transfer entropy, and Mutualinfo or other jpype1's content, the sub content like prop_k, k_history, l_history is different from idtxl's documentation, https://pwollstadt.github.io/IDTxl/html/index.html. (2) For some other simple SPI, what;s the meaning of statistic:max\min?

If you could include more descriptions of these things (and more details) in the documentation,then we can get a lot of help. Very thanks for your any reply!

jmoo2880 commented 7 months ago

Hi @ChenK19, The pyspi documentation has recently been updated to include descriptions of all the SPIs currently included in the toolkit. This includes details regarding their specific implementation and explanations of the various estimators. You can access the docs here. I hope you find this useful! Feel free to ping us if you have any further questions.