sappelhoff / pyprep

PyPREP: A Python implementation of the Preprocessing Pipeline (PREP) for EEG data
https://pyprep.readthedocs.io/en/latest/
MIT License
136 stars 33 forks source link

Improve documentation for PyPREP/MatPREP highpass differences #110

Closed a-hurst closed 2 years ago

a-hurst commented 2 years ago

PR Description

Closes #107. This PR updates the docs to contain a better explanation of the differences between PyPREP's and MatPREP's trend removal filters (and why the MNE method is technically preferable).

Wasn't sure if this warranted an addition in the whats_new.rst, but if it does I can definitely add a line!

Merge Checklist

a-hurst commented 2 years ago

Er, looks like MNE needs an additional module to download test datasets now? Should I add that to this PR as well?

sappelhoff commented 2 years ago

ah right :thinking: yes please - we can just add it here: https://github.com/sappelhoff/pyprep/blob/master/requirements-dev.txt

sappelhoff commented 2 years ago

although pooch may soon be installed automatically when we install mne, see: https://github.com/mne-tools/mne-python/pull/10199

but no harm in adding it now to merge this PR, and then removing it again some time in the future when we don't need to declare it explicitly anymore.

a-hurst commented 2 years ago

Whoops, looks like matplotlib's changed its API on us since last update too. I'll try to tackle that as well.

codecov-commenter commented 2 years ago

Codecov Report

Merging #110 (301c458) into master (12047bf) will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #110   +/-   ##
=======================================
  Coverage   99.04%   99.04%           
=======================================
  Files           7        7           
  Lines         733      733           
=======================================
  Hits          726      726           
  Misses          7        7           

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 12047bf...301c458. Read the comment docs.

sappelhoff commented 2 years ago

Thank you :)