File: README.rst

package info (click to toggle)
python-nanomath 1.4.0%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 164 kB
  • sloc: python: 300; sh: 10; makefile: 9
file content (58 lines) | stat: -rw-r--r-- 1,839 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
nanomath
========

This module provides a few simple math and statistics functions for
other scripts processing Oxford Nanopore sequencing data

|Twitter URL| |install with conda| |install with Debian|

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
------------

.. code:: bash

   pip install nanomath

| or
| |install with conda|

::

   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>`__.

.. |Twitter URL| image:: https://img.shields.io/twitter/url/https/twitter.com/wouter_decoster.svg?style=social&label=Follow%20%40wouter_decoster
   :target: https://twitter.com/wouter_decoster
.. |install with conda| image:: https://anaconda.org/bioconda/nanomath/badges/installer/conda.svg
   :target: https://anaconda.org/bioconda/nanomath
.. |install with Debian| image:: https://www.debian.org/logos/button-mini.png
   :target: https://tracker.debian.org/pkg/python-nanomath