[Review] Improve documentation

[vferat]

Code

• Improve control of ModK.plot()

Documentation

• Add bibliography
• Add glossary
• Add Note to explain invert_polarity purpose
• Improve metrics tutorial
• Improve resampling tutorial
  • Replicate Cartool pipelines
  • Study stability of topographies

Paper

• Add missing python packages (neurokit, keypy)
• Add more details on the value offered by Pycrostates including:
  • Class based implementation (reusable components)
  • Group level analysis
  • Advanced segmentation (smoothing)

[codecov]

Codecov Report

Merging #81 (7c1ba49) into main (5cedca5) will decrease coverage by 0.00%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main      #81      +/-   ##
==========================================
- Coverage   96.34%   96.33%   -0.01%     
==========================================
  Files          56       54       -2     
  Lines        4127     4120       -7     
==========================================
- Hits         3976     3969       -7     
  Misses        151      151              

Impacted Files	Coverage Δ
pycrostates/cluster/kmeans.py	97.77% <ø> (ø)
pycrostates/metrics/calinski_harabasz.py	100.00% <ø> (ø)
pycrostates/metrics/davies_bouldin.py	97.50% <ø> (ø)
pycrostates/metrics/dunn.py	100.00% <ø> (ø)
pycrostates/metrics/silhouette.py	100.00% <ø> (ø)
pycrostates/preprocessing/extract_gfp_peaks.py	100.00% <ø> (ø)
pycrostates/viz/cluster_centers.py	94.64% <ø> (ø)
pycrostates/cluster/_base.py	93.42% <100.00%> (+0.01%)	⬆️
pycrostates/tests/test_utils.py
pycrostates/__init__.py

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[mscheltienne]

Couple of comments while I had some wifi, energy and time :)

I haven't noted all the mentions of (thus, thuse,) or of leading space, or 'summurizes'.

Have a look when you have time, I'll have a look again when I'll get back ;)

[mscheltienne]

LGTM