edit

.gitignore

@@ -154,3 +154,5 @@ dmypy.json
 cython_debug/
 
 # End of https://www.toptal.com/developers/gitignore/api/python,jupyternotebooks
+
+.DS_Store

docs/algorithms/index.md

@@ -4,9 +4,108 @@ Beat detection algorithms
 
 ---
 
-**PPG-beats** contains several algorithms ...
+**PPG-beats** contains several algorithms to detect beats in the photoplethysmogram (PPG):
 
-## Algorithm one
+## Automatic Beat Detection
 
-## Algorithm two
+**Original publication:** Aboy M et al., An automatic beat detection algorithm for pressure signals. _IEEE Trans Biomed Eng_ 2005; 52: 1662-70. DOI: [10.1109/TBME.2005.855725](https://doi.org/10.1109/TBME.2005.855725)
 
+**Description:** 
+
+**Link:** 
+
+## Automatic Multiscale-based Peak Detection
+
+**Original publication:** F. Scholkmann et al., 'An efficient algorithm forautomatic peak detection in noisy periodic and quasi-periodic signals,'_Algorithms_, vol. 5, no. 4, pp. 588-603, 2012. DOI: [10.3390/a5040588](https://doi.org/10.3390/a5040588)
+
+**Description:** 
+
+**Link:** 
+
+## Percentile Peak Detector
+
+**Original publication:** C. Orphanidou et al., 'Signal-quality indices for the electrocardiogram and photoplethysmogram: derivation and applications to wireless monitoring,' _IEEE Journal of Biomedical and Health Informatics_, vol. 19, no. 3, pp. 832-8, 2015. DOI: [10.1109/JBHI.2014.2338351](https://doi.org/10.1109/JBHI.2014.2338351)
+
+**Description:** 
+
+**Link:** 
+
+## Event-Related Moving Averages
+
+**Original publication:** M. Elgendi et al., 'Systolic peak detection in accelerationphotoplethysmograms measured from emergency responders in tropicalconditions,' _PLoS ONE_, vol. 8, no. 10, pp. 1-11, 2013. DOI: [10.1371/journal.pone.0076585](https://doi.org/10.1371/journal.pone.0076585)
+
+**Description:** 
+
+**Link:** 
+
+## HeartPy
+
+**Original publication:** P. van Gent et al., 'HeartPy: A novel heart rate algorithm for theanalysis of noisy signals,' _Transportation Research Part F: TrafficPsychology and Behaviour_, vol. 66, pp. 368-378, 2019. DOI: [10.1016/j.trf.2019.09.015](https://doi.org/10.1016/j.trf.2019.09.015)
+
+**Description:** 
+
+**Link:** 
+
+## Incremental Merge Segmentation
+
+**Original publication:** W. Karlen et al., 'Adaptive pulse segmentation and artifact detection in photoplethysmography for mobile applications,' in _Proc. IEEE EMBS_. IEEE, 2012, pp. 3131-4. DOI: [10.1109/EMBC.2012.6346628](https://doi.org/10.1109/EMBC.2012.6346628)
+
+**Description:** 
+
+**Link:** 
+
+## Multi-Scale Peak and Trough Detection
+
+**Original publication:** S. M. Bishop and A. Ercole, 'Multi-scale peak and trough detection optimised for periodic and quasi-periodic neuroscience data,' in _Intracranial Pressure and Neuromonitoring XVI. Acta Neurochirurgica Supplement_, T. Heldt, Ed. Springer, 2018, vol. 126, pp. 189-195. DOI: [10.1007/978-3-319-65798-1_39](https://doi.org/10.1007/978-3-319-65798-1_39)
+
+**Description:** 
+
+**Link:** 
+
+## Peak Detection Algorithm
+
+**Original publication:** E. J. Arguello Prada and R. D. Serna Maldonado, 'A novel andlow-complexity peak detection algorithm for heart rate estimation from low-amplitude photoplethysmographic (PPG) signals,' _Journal of Medical Engineering and Technology_, vol. 42, no. 8, pp. 569-577, 2018. DOI: [10.1080/03091902.2019.1572237](https://doi.org/10.1080/03091902.2019.1572237)
+
+**Description:** 
+
+**Link:** 
+
+## Pulse Wave Delineator
+
+**Original publication:** B. N. Li et al., 'On an automatic delineator for arterial blood pressure waveforms,' _Biomedical Signal Processing and Control_, vol. 5, no. 1, pp. 76-81, 2010. DOI: [10.1016/j.bspc.2009.06.002](https://doi.org/10.1016/j.bspc.2009.06.002)
+
+**Description:** 
+
+**Link:** 
+
+## PPG Pulses Detector
+
+**Original publication:** J. Lazaro et al., 'Pulse rate variability analysis for discrimination of sleep-apnea-related decreases in the amplitude fluctuations of pulsephotoplethysmographic signal in children,' _IEEE Journal of Biomedical and Health Informatics_, vol. 18, no. 1, pp. 240-246, 2014. DOI: [10.1109/JBHI.2013.2267096](https://doi.org/10.1109/JBHI.2013.2267096)
+
+**Description:** 
+
+**Link:** 
+
+## Adapted Onset Detector
+
+**Original publication:** A. N. Vest et al., 'An open source benchmarked toolbox for cardiovascular waveform and interval analysis,' _Physiological Measurement_, vol. 39, no. 10, 2018. DOI: [10.1088/1361-6579/aae021](https://doi.org/10.1088/1361-6579/aae021)
+
+**Description:** 
+
+**Link:** 
+
+## Symmetric Projection Attractor Reconstruction Detector
+
+**Original publication:**  n/a
+
+**Description:** 
+
+**Link:** 
+
+## Wavelet Foot Delineation
+
+**Original publication:** N. J. Conn and D. A. Borkholder, 'Wavelet based photoplethysmogram foot delineation for heart rate variability applications,' in _IEEE Signal Processing in Medicine and Biology Symposium_. IEEE, 2013. DOI: [10.1109/SPMB.2013.6736782](https://doi.org/10.1109/SPMB.2013.6736782)
+
+**Description:** 
+
+**Link:** 

mkdocs.yml

@@ -4,9 +4,7 @@ repo_url: https://github.com/peterhcharlton/ppg-beats
 nav:
     - 'Home': 'index.md'
     - 'Getting Started': './getting_started/index.md'
-    - 'Algorithms':
-      - 'Overview': './algorithms/index.md'
-      - 'Algorithm one': './algorithms/algorithm_one.md'
+    - 'Algorithms': './algorithms/index.md'
     - 'Assessing Performance':
       - 'Overview': './assessing_performance/index.md'
       - 'Datasets': './assessing_performance/datasets/index.md'