neuropsychology / NeuroKit

NeuroKit2: The Python Toolbox for Neurophysiological Signal Processing

https://neuropsychology.github.io/NeuroKit

MIT License

1.58k stars 421 forks source link

[Fix] GUDB name consistency #1016

Closed danibene closed 3 months ago

danibene commented 3 months ago

Description

This PR aims to improve consistency in the naming of the GUDB database for R-Peak annotations and raw ECG data. I think a difference in naming could be problematic when selecting subsets of data for benchmarking:

https://github.com/neuropsychology/NeuroKit/blob/d42a2306a68efb5f59e5a86b4fac95dc5ff5359b/neurokit2/benchmark/benchmark_ecg.py#L83-L85

Proposed Changes

I changed download_gudb.py so that the database name for R-peaks uses an underscore instead of parentheses: https://github.com/neuropsychology/NeuroKit/blob/d42a2306a68efb5f59e5a86b4fac95dc5ff5359b/data/gudb/download_gudb.py#L44

Such that it matches the corresponding name for raw ECG data: https://github.com/neuropsychology/NeuroKit/blob/d42a2306a68efb5f59e5a86b4fac95dc5ff5359b/data/gudb/download_gudb.py#L38

Checklist

[x] I have read the CONTRIBUTING file.
[x] My PR is targeted at the dev branch (and not towards the master branch).
[ ] I ran the CODE CHECKS on the files I added or modified and fixed the errors.