# nanomath
This module provides a few simple math and statistics functions for other scripts processing Oxford Nanopore sequencing data
[![Twitter URL](https://img.shields.io/twitter/url/https/twitter.com/wouter_decoster.svg?style=social&label=Follow%20%40wouter_decoster)](https://twitter.com/wouter_decoster)
[![install with conda](https://anaconda.org/bioconda/nanomath/badges/installer/conda.svg)](https://anaconda.org/bioconda/nanomath)
[![install with Debian](https://www.debian.org/logos/button-mini.png)](https://tracker.debian.org/pkg/python-nanomath)
## FUNCTIONS
* Calculate read N50 from a set of lengths `get_N50(readlenghts)`
* Remove extreme length outliers from a dataset `remove_length_outliers(dataframe, columname)`
* Calculate the average Phred quality of a read `ave_qual(qualscores)`
* Write out the statistics report after calling readstats function `write_stats(dataframe, outputname)`
* Compute a number of statistics, return a dictionary `calc_read_stats(dataframe)`
As of **v1.3.0**, nanomath calculates the average quality differently, by first converting per-read phred scale averages to error rates, take the average, and converting back ([nanostat#40](<https://github.com/wdecoster/nanostat/issues/40>))
## INSTALLATION
```bash
pip install nanomath
```
or
[![install with conda](https://anaconda.org/bioconda/nanomath/badges/installer/conda.svg)](https://anaconda.org/bioconda/nanomath)
```
conda install -c bioconda nanomath
```
## CONTRIBUTORS
[@alexomics](https://github.com/alexomics) for fixing the indentation of the printed stats
## CITATION
If you use this tool, please consider citing our [publication](https://academic.oup.com/bioinformatics/advance-article/doi/10.1093/bioinformatics/bty149/4934939).
Raw data
{
"_id": null,
"home_page": "https://github.com/wdecoster/nanomath",
"name": "nanomath",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": null,
"keywords": "nanopore sequencing plotting quality control",
"author": "Wouter De Coster",
"author_email": "decosterwouter@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/fd/e5/4ce733aa2f62470fd79523a56f55033589394b49b2ee746521db16e5846a/nanomath-1.4.0.tar.gz",
"platform": null,
"description": "# nanomath\n\nThis module provides a few simple math and statistics functions for other scripts processing Oxford Nanopore sequencing data\n\n[![Twitter URL](https://img.shields.io/twitter/url/https/twitter.com/wouter_decoster.svg?style=social&label=Follow%20%40wouter_decoster)](https://twitter.com/wouter_decoster)\n[![install with conda](https://anaconda.org/bioconda/nanomath/badges/installer/conda.svg)](https://anaconda.org/bioconda/nanomath)\n[![install with Debian](https://www.debian.org/logos/button-mini.png)](https://tracker.debian.org/pkg/python-nanomath)\n\n## FUNCTIONS\n\n* Calculate read N50 from a set of lengths `get_N50(readlenghts)` \n* Remove extreme length outliers from a dataset `remove_length_outliers(dataframe, columname)` \n* Calculate the average Phred quality of a read `ave_qual(qualscores)` \n* Write out the statistics report after calling readstats function `write_stats(dataframe, outputname)` \n* Compute a number of statistics, return a dictionary `calc_read_stats(dataframe)` \n\nAs of **v1.3.0**, nanomath calculates the average quality differently, by first converting per-read phred scale averages to error rates, take the average, and converting back ([nanostat#40](<https://github.com/wdecoster/nanostat/issues/40>))\n\n## INSTALLATION\n\n```bash\npip install nanomath\n```\n\nor \n[![install with conda](https://anaconda.org/bioconda/nanomath/badges/installer/conda.svg)](https://anaconda.org/bioconda/nanomath)\n\n```\nconda install -c bioconda nanomath\n```\n\n## CONTRIBUTORS\n\n[@alexomics](https://github.com/alexomics) for fixing the indentation of the printed stats\n\n## CITATION\n\nIf you use this tool, please consider citing our [publication](https://academic.oup.com/bioinformatics/advance-article/doi/10.1093/bioinformatics/bty149/4934939).\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "A few simple math function for other Oxford Nanopore processing scripts",
"version": "1.4.0",
"project_urls": {
"Homepage": "https://github.com/wdecoster/nanomath"
},
"split_keywords": [
"nanopore",
"sequencing",
"plotting",
"quality",
"control"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fde54ce733aa2f62470fd79523a56f55033589394b49b2ee746521db16e5846a",
"md5": "bf465d2e3538cffa394c5dc1a0f96447",
"sha256": "ed7a38fbb156d9a68a95c2570fe3c2035321d0a3e234580496750afca4927ced"
},
"downloads": -1,
"filename": "nanomath-1.4.0.tar.gz",
"has_sig": false,
"md5_digest": "bf465d2e3538cffa394c5dc1a0f96447",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 18829,
"upload_time": "2024-06-14T19:11:19",
"upload_time_iso_8601": "2024-06-14T19:11:19.514738Z",
"url": "https://files.pythonhosted.org/packages/fd/e5/4ce733aa2f62470fd79523a56f55033589394b49b2ee746521db16e5846a/nanomath-1.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-14 19:11:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "wdecoster",
"github_project": "nanomath",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"lcname": "nanomath"
}