Skip to content

Commit

Permalink
edit
Browse files Browse the repository at this point in the history
  • Loading branch information
peterhcharlton committed Jan 23, 2022
1 parent 22621e2 commit b6dd34a
Show file tree
Hide file tree
Showing 7 changed files with 26 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -155,4 +155,4 @@ cython_debug/

# End of https://www.toptal.com/developers/gitignore/api/python,jupyternotebooks

.DS_Store
**/.DS_Store
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# PPG-beats README

**PPG-beats** is a Matlab library of algorithms to detect heartbeats in photoplethysmogram (*PPG*) signals.

```NB: The toolbox is currently under preparation.```

The accompanying documentation is available [here](https://ppg-beats.readthedocs.io/en/latest/).

Full details of the project are available at the [project website](https://peterhcharlton.github.io/project/ppg-beats/).
Binary file modified docs/assessing_performance/.DS_Store
Binary file not shown.
5 changes: 5 additions & 0 deletions docs/tutorials/beat_detection/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Beat Detection

This page provides ...

## Beat Detection Tutorial 1
4 changes: 2 additions & 2 deletions docs/tutorials/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Tutorials

## Beat Detection
These tutorials give a quick introduction to detecting heartbeats in PPG signals, and assessing the performance of PPG beat detectors.

This set of tutorials is designed to give a quick introduction to detecting heartbeats in PPG signals.
---
5 changes: 5 additions & 0 deletions docs/tutorials/performance_assessment/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Performance Assessment

This page provides ...

## Performance Assessment Tutorial 1
5 changes: 4 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,7 @@ nav:
- 'Assessing Performance':
- 'Overview': './assessing_performance/index.md'
- 'Datasets': './assessing_performance/datasets/index.md'
- 'Tutorials': './tutorials/index.md'
- 'Tutorials':
- 'Overview': './tutorials/index.md'
- 'Beat Detection': './tutorials/beat_detection/index.md'
- 'Performance Assessment': './tutorials/performance_assessment/index.md'

0 comments on commit b6dd34a

Please sign in to comment.