0.2.7

[DominiqueMakowski]

Roadmap

RSP

• Add rsp_segment() (similar to ppg_segment())
• Add the cycle overlay plots to RSP
• Streamline rsp_plot() (same as ppg_plot())

PPG

• Detect PPG diastolic peaks? (between each peak and the next trough)
  • derivatives
  • model
• Add PPG amplitude calculation (reduction can be indicative of vasoconstriction in stress, cold)
• Document peak-extraction methods (PPG)
• add more PPG detectors (@peterhcharlton)
• hrv_rsa(): Add method argument to compute only one RSA signal. Do something with warning that will be thrown when using bio_process() on signals < 32 sec where it will complain that the signal is too short to compute RSA with one of these methods.

Misc

• we should also do a global search of " ``...()`` " and replace by " :func:`...` " to have hyperlinks in the docs across functions
• Dynamic plots: @danibene instead of re-plotting with plotly, can't we just turn the existing matplotlib figs as interactive in htmls?
• Fix ECG Analysis bug for sample rate of 500 #593

Complexity

• Add quadratic sample entropy?
  • https://umu.diva-portal.org/smash/get/diva2:1068270/FULLTEXT01.pdf
  • https://github.com/kirajcg/pysampen/blob/master/pysampen/sampen.py#L79

[codecov-commenter]

Codecov Report

Attention: 142 lines in your changes are missing coverage. Please review.

Comparison is base (ce33299) 55.19% compared to head (c1e38e1) 54.87%.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #901      +/-   ##
==========================================
- Coverage   55.19%   54.87%   -0.33%     
==========================================
  Files         302      303       +1     
  Lines       14143    14255     +112     
==========================================
+ Hits         7806     7822      +16     
- Misses       6337     6433      +96     

Files	Coverage Δ
neurokit2/__init__.py	85.36% <100.00%> (ø)
neurokit2/complexity/__init__.py	100.00% <100.00%> (ø)
neurokit2/complexity/entropy_approximate.py	47.82% <100.00%> (ø)
neurokit2/complexity/entropy_sample.py	90.00% <100.00%> (ø)
neurokit2/complexity/utils_entropy.py	81.03% <100.00%> (ø)
neurokit2/ecg/ecg_clean.py	75.60% <100.00%> (ø)
neurokit2/ecg/ecg_peaks.py	80.30% <ø> (ø)
neurokit2/ecg/ecg_plot.py	89.65% <ø> (ø)
neurokit2/hrv/intervals_process.py	90.00% <100.00%> (ø)
neurokit2/complexity/entropy_multiscale.py	55.10% <83.33%> (+0.84%)	⬆️
... and 10 more

... and 2 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[DominiqueMakowski]

@danibene the docs CI flagged the intervals_process() function in hrv/intervals_process, but looking at it 1) I'm super suprised it hasn't been detected before because the example likely never ran; 2) the example seems weird; 3) it makes me wonder whether this should even be an exported function, or whether we should turn it into an internal _preprocess_rpeaks_intervals()

any thoughts?

[danibene]

@danibene the docs CI flagged the intervals_process() function in hrv/intervals_process, but looking at it 1) I'm super suprised it hasn't been detected before because the example likely never ran; 2) the example seems weird; 3) it makes me wonder whether this should even be an exported function, or whether we should turn it into an internal _preprocess_rpeaks_intervals()

any thoughts?

1. yeah I'm not sure either why it's being flagged now
2. what about the example seems weird? Maybe we could show how it can be used prior to the hrv functions? (So that the R-R intervals are given as an input?)
3. I don't think so, this would then prevent processing the R-R intervals prior to time-domain or nonlinear HRV feature computation. Though admittedly, this is probably not well known/documented enough for users to be using it this way

To provide more context, in kubios the R-R intervals are detrended https://www.kubios.com/hrv-preprocessing/

[codeclimate]

Code Climate has analyzed commit c1e38e1 and detected 1 issue on this pull request.

Here's the issue category breakdown:

Category	Count
Complexity	1

View more on Code Climate.