neuropsychology / NeuroKit

NeuroKit2: The Python Toolbox for Neurophysiological Signal Processing
https://neuropsychology.github.io/NeuroKit
MIT License
1.58k stars 421 forks source link

[Docs] Revise definition of pNN50 and pNN20 #1013

Closed danibene closed 4 months ago

danibene commented 4 months ago

Description

This PR aims to improve the definitions of pNN50 and pNN20, which currently describe these features as being the proportion of RR intervals greater than 50/20 ms, but I think we should specify that these features are based on the absolute difference between successive RR intervals (rather than the RR intervals themselves, which we would normally expect to be well above 50 ms).

Proposed Changes

I changed the docstring of the hrv_time() function so that it contains the following definition adapted from Mietus et al. (2002): The percentage of absolute differences in successive RR intervals greater than 20/50 ms

I also added references to Mietus et al. (2002) and Bigger et al. (1988)

Checklist