Update Example Documentation + Tests

[zen-juen]

A lot of new features and fixes have happened since we last updated our documentation + tests so now's a good time for making sure they are up-to-date!

Example Docs

• [ ] Complexity introduction: we have a primer on complexity analysis here but a lot of functions have been added since on fractality/entropy etc. so it'll be nice to give a more complete picture of the different measures (ref our preprint)
• [ ] Add complexity analysis example: perhaps one with ecg and another with eeg signals
• [ ] EEG Spectral analysis using eeg_power()
• [ ] Fix all syntax/grammatical errors/typos in any example docs (code functionality was checked already in this PR https://github.com/neuropsychology/NeuroKit/pull/577 but good to have some extra 👀 )

Tests

• complexity functions
  • we have some existing tests where we test specifically the values of straightforward measures like sample/approximate entropy but it's still unclear how best to test the new ones, I thought it'll be good to explicitly test the algorithmic implementations but this might be convoluted because there is no specific benchmark to test against especially those with multiple parameters. we welcome any ideas on this!
• docstrings (especially with the newer functions - my bad for putting #doctest: +SKIP oops 😆 note to replace these with #doctest: +ELLIPSIS)

[zen-juen]

Tagging @anshu-97 and @claudia-liauw here 😄

[stale[bot]]

Is this still relevant? If so, what is blocking it? Is there anything you can do to help move it forward?

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.