Add .pre-commit-config.yaml

docs/user_guide/physio.rst

@@ -9,7 +9,7 @@
 The ``Physio`` data object
 --------------------------
 
-The primary funtionality of :py:mod:`peakdet` relies on its operations being
+The primary functionality of :py:mod:`peakdet` relies on its operations being
 performed on physiological data loaded into a :py:class:`peakdet.Physio`
 object. So, before we get into using :py:mod:`peakdet`, its best to understand
 a little bit about this helper class!

peakdet/__init__.py

@@ -19,9 +19,15 @@
 from peakdet.analytics import HRV
 from peakdet.external import load_rtpeaks
 from peakdet.io import load_history, load_physio, save_history, save_physio
-from peakdet.operations import (delete_peaks, edit_physio, filter_physio,
-                                interpolate_physio, peakfind_physio,
-                                plot_physio, reject_peaks)
+from peakdet.operations import (
+    delete_peaks,
+    edit_physio,
+    filter_physio,
+    interpolate_physio,
+    peakfind_physio,
+    plot_physio,
+    reject_peaks,
+)
 from peakdet.physio import Physio
 
 from ._version import get_versions

peakdet/_version.py

@@ -292,7 +292,7 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command):
         # TAG-NUM-gHEX
         mo = re.search(r"^(.+)-(\d+)-g([0-9a-f]+)$", git_describe)
         if not mo:
-            # unparseable. Maybe git-describe is misbehaving?
+            # unparsable. Maybe git-describe is misbehaving?
             pieces["error"] = "unable to parse git-describe output: '%s'" % describe_out
             return pieces
 

peakdet/operations.py

@@ -107,7 +107,7 @@ def interpolate_physio(data, target_fs, *, kind="cubic"):
 @utils.make_operation()
 def peakfind_physio(data, *, thresh=0.2, dist=None):
     """
-    Performs peak and trough detection on `data`
+    Performs peak and through detection on `data`
 
     Parameters
     ----------
@@ -139,7 +139,7 @@ def peakfind_physio(data, *, thresh=0.2, dist=None):
     heights = np.percentile(heights["peak_heights"], 1)
     locs, heights = signal.find_peaks(data[:], distance=cdist, height=heights)
     data._metadata["peaks"] = locs
-    # perform trough detection based on detected peaks
+    # perform through detection based on detected peaks
     data._metadata["troughs"] = utils.check_troughs(data, data.peaks)
 
     return data

peakdet/physio.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Helper class for holding physiological data and associated metadata inforamtion
+Helper class for holding physiological data and associated metadata information
 """
 
 import numpy as np

peakdet/utils.py

@@ -225,7 +225,7 @@ def check_troughs(data, peaks, troughs=None):
     Returns
     -------
     troughs : np.ndarray
-        Indices of trough locations in `data`, dependent on `peaks`
+        Indices of through locations in `data`, dependent on `peaks`
     """
     # If there's a through after all peaks, keep it.
     if troughs is not None and troughs[-1] > peaks[-1]: