# [detecta](https://pypi.org/project/detecta/)
Python module to detect events in data
The following functions are implemented in detecta:
- **detect_peaks.py**: detects peaks in data based on their amplitude and other features.
- **detect_onset.py**: detects onset in data based on amplitude threshold.
- **detect_cusum.py**: detects abrupt changes in data using cumulative sum algorithm (CUSUM).
- **detect_seq.py**: detects initial and final indices of sequential data identical to a parameter.
## Installation
```bash
pip install detecta
```
Or
```bash
conda install -c duartexyz detecta
```
## Examples
- [detect_peaks](https://nbviewer.jupyter.org/github/demotu/detecta/blob/master/docs/detect_peaks.ipynb)
- [detect_onset](https://nbviewer.jupyter.org/github/demotu/detecta/blob/master/docs/detect_onset.ipynb)
- [detect_cusum](https://nbviewer.jupyter.org/github/demotu/detecta/blob/master/docs/detect_cusum.ipynb)
- [detect_seq](https://nbviewer.jupyter.org/github/demotu/detecta/blob/master/docs/detect_seq.ipynb)
## How to cite this work
Here is a suggestion to cite this GitHub repository:
> Duarte, M. (2020) detecta: A Python module to detect events in data. GitHub repository, <https://github.com/demotu/detecta>.
And a possible BibTeX entry:
```tex
@misc{Duarte2020,
author = {Duarte, M.},
title = {detecta: A Python module to detect events in data},
year = {2020},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/demotu/detecta}}
}
```
## License
The non-software content of this project is licensed under a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/), and the software code is licensed under the [MIT license](https://opensource.org/licenses/mit-license.php).
Raw data
{
"_id": null,
"home_page": "https://github.com/demotu/detecta",
"name": "detecta",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Marcos Duarte",
"author_email": "duartexyz@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/58/8c/8eef3b0d059d000fce70497b925507a370a1c320949826814dcd09bf5ac2/detecta-0.0.5.tar.gz",
"platform": "",
"description": "# [detecta](https://pypi.org/project/detecta/)\n\nPython module to detect events in data\n\nThe following functions are implemented in detecta: \n\n- **detect_peaks.py**: detects peaks in data based on their amplitude and other features. \n- **detect_onset.py**: detects onset in data based on amplitude threshold. \n- **detect_cusum.py**: detects abrupt changes in data using cumulative sum algorithm (CUSUM). \n- **detect_seq.py**: detects initial and final indices of sequential data identical to a parameter.\n\n## Installation\n\n```bash\npip install detecta\n```\n\nOr\n\n```bash\nconda install -c duartexyz detecta\n```\n\n## Examples\n\n- [detect_peaks](https://nbviewer.jupyter.org/github/demotu/detecta/blob/master/docs/detect_peaks.ipynb) \n- [detect_onset](https://nbviewer.jupyter.org/github/demotu/detecta/blob/master/docs/detect_onset.ipynb) \n- [detect_cusum](https://nbviewer.jupyter.org/github/demotu/detecta/blob/master/docs/detect_cusum.ipynb) \n- [detect_seq](https://nbviewer.jupyter.org/github/demotu/detecta/blob/master/docs/detect_seq.ipynb) \n\n## How to cite this work\n\nHere is a suggestion to cite this GitHub repository:\n\n> Duarte, M. (2020) detecta: A Python module to detect events in data. GitHub repository, <https://github.com/demotu/detecta>.\n\nAnd a possible BibTeX entry:\n\n```tex\n@misc{Duarte2020, \n author = {Duarte, M.},\n title = {detecta: A Python module to detect events in data}, \n year = {2020}, \n publisher = {GitHub}, \n journal = {GitHub repository}, \n howpublished = {\\url{https://github.com/demotu/detecta}} \n}\n```\n\n## License\n\nThe non-software content of this project is licensed under a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/), and the software code is licensed under the [MIT license](https://opensource.org/licenses/mit-license.php).\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Detect events in data",
"version": "0.0.5",
"project_urls": {
"Homepage": "https://github.com/demotu/detecta"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "efda0bf9676a6b7e5d723ed7f40b91f4ece5d4ccfb124103eae1bf61aab47b06",
"md5": "83e32388c786172528b68503a5f085e1",
"sha256": "dbaf1938e5d785386c904034e2553824e2aa31793e967984ca65983aca06d23e"
},
"downloads": -1,
"filename": "detecta-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "83e32388c786172528b68503a5f085e1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 12435,
"upload_time": "2020-03-29T19:22:37",
"upload_time_iso_8601": "2020-03-29T19:22:37.449949Z",
"url": "https://files.pythonhosted.org/packages/ef/da/0bf9676a6b7e5d723ed7f40b91f4ece5d4ccfb124103eae1bf61aab47b06/detecta-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "588c8eef3b0d059d000fce70497b925507a370a1c320949826814dcd09bf5ac2",
"md5": "9b28fd8bab1249f708926f73cefb7213",
"sha256": "d2ea7d13dfbbc994d6ce385a7f8dc0a85fe675a8a8e712a64ec56e54c40603ed"
},
"downloads": -1,
"filename": "detecta-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "9b28fd8bab1249f708926f73cefb7213",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 9301,
"upload_time": "2020-03-29T19:22:38",
"upload_time_iso_8601": "2020-03-29T19:22:38.485639Z",
"url": "https://files.pythonhosted.org/packages/58/8c/8eef3b0d059d000fce70497b925507a370a1c320949826814dcd09bf5ac2/detecta-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2020-03-29 19:22:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "demotu",
"github_project": "detecta",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "detecta"
}
JSON
