Installation
------------
Pypi/pip
~~~~~~~~
.. code:: bash
pip install read5_ont
Conda
~~~~~
Pod5 is now available via `conda <https://anaconda.org/jannessp/pod5>`__ (19.07.2023).
.. code:: bash
conda install mamba
mamba create -n read5_ont -c jannessp read5_ont
conda activate read5_ont
Alternatively you can create the environment using the
`conda.recipe/env.yml <conda.recipe/env.yml>`__ file.
.. code:: bash
conda install mamba
mamba env create -f conda.recipe/env.yml
conda activate read5_ont
--------------
Usage
-----
`Click here to see a full documentation about the classes and
function. <https://jannessp.github.io/read5.github.io/>`__
*my_file* can be a fast5 or pod5 file. The wrapper detects
the file format depending on the file extension.
Small example:
~~~~~~~~~~~~~~
.. code:: python
from read5 import read # or from read5.Reader import read
r5 = read(my_file) # file with on of these extensions: .fast5, .pod5
for readid in r5:
signal = r5.getSignal(readid) # returns raw integer values stored in the file
pA_signal = r5.getpASignal(readid) # returns pA signal
norm_signal = r5.getZNormSignal(readid) # returns normalised read signal: norm_signal = (signal - median(signal)) / mad(signal)
polyAstdSignal = r5.getPolyAStandardizedSignal(readid, polyAstart, polyAend) # returns polyA standardized read signal
channel = r5.getChannelNumber(readid)
sampleid = r5.getSampleID(readid)
runid = r5.getRunID(readid)
readid_list = r5.getReads()
File Reader Classes
~~~~~~~~~~~~~~~~~~~
If you want to use the file readers you can import the corresponding
class like this:
.. code:: python
from read5.Fast5Reader import Fast5Reader # contains the Fast5 Reader class
from read5.Pod5Reader import Pod5Reader # contains the Pod5 Reader class
Abstract File Reader Class
~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code:: python
from read5.AbstractFileReader import AbstractFileReader
Possible Exceptions
~~~~~~~~~~~~~~~~~~~
.. code:: python
from read5.Exceptions import UnknownFileFormatException, UnknownNormalizationMode
- UnknownFileFormatException: is raised, when the file extension does
not match one of [‘.fast5’, ‘.pod5’]
- UnknownNormalizationMode: is raised, when an unknown mode is provided
for the signal normalization function
Full Documentation
------------------
Created with `pdoc3 <https://pdoc3.github.io/pdoc/>`__. Can be found
`here <https://jannessp.github.io/read5.github.io/>`__.
Raw data
{
"_id": null,
"home_page": "https://github.com/JannesSP/read5",
"name": "read5-ont",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "read5, fast5, pod5, ONT, Oxford Nanopore Technologies, Nanopore, raw data, wrapper",
"author": "Jannes Spangenberg",
"author_email": "jannes.spangenberg@uni-jena.de",
"download_url": "https://files.pythonhosted.org/packages/55/13/2702a1079e0af72ebb52fcc08645803178b7c49f92b89128e670435f993e/read5_ont-1.2.5.tar.gz",
"platform": null,
"description": "Installation\n------------\n\nPypi/pip\n~~~~~~~~\n\n.. code:: bash\n\n pip install read5_ont\n\nConda\n~~~~~\n\nPod5 is now available via `conda <https://anaconda.org/jannessp/pod5>`__ (19.07.2023).\n\n.. code:: bash\n\n conda install mamba\n mamba create -n read5_ont -c jannessp read5_ont\n conda activate read5_ont\n\nAlternatively you can create the environment using the\n`conda.recipe/env.yml <conda.recipe/env.yml>`__ file.\n\n.. code:: bash\n\n conda install mamba\n mamba env create -f conda.recipe/env.yml\n conda activate read5_ont\n\n--------------\n\nUsage\n-----\n\n`Click here to see a full documentation about the classes and\nfunction. <https://jannessp.github.io/read5.github.io/>`__\n\n*my_file* can be a fast5 or pod5 file. The wrapper detects\nthe file format depending on the file extension.\n\nSmall example:\n~~~~~~~~~~~~~~\n\n.. code:: python\n\n from read5 import read # or from read5.Reader import read\n\n r5 = read(my_file) # file with on of these extensions: .fast5, .pod5\n for readid in r5:\n signal = r5.getSignal(readid) # returns raw integer values stored in the file\n pA_signal = r5.getpASignal(readid) # returns pA signal\n norm_signal = r5.getZNormSignal(readid) # returns normalised read signal: norm_signal = (signal - median(signal)) / mad(signal)\n polyAstdSignal = r5.getPolyAStandardizedSignal(readid, polyAstart, polyAend) # returns polyA standardized read signal\n channel = r5.getChannelNumber(readid)\n sampleid = r5.getSampleID(readid)\n runid = r5.getRunID(readid)\n\n readid_list = r5.getReads()\n\nFile Reader Classes\n~~~~~~~~~~~~~~~~~~~\n\nIf you want to use the file readers you can import the corresponding\nclass like this:\n\n.. code:: python\n\n from read5.Fast5Reader import Fast5Reader # contains the Fast5 Reader class\n from read5.Pod5Reader import Pod5Reader # contains the Pod5 Reader class\n\nAbstract File Reader Class\n~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n.. code:: python\n\n from read5.AbstractFileReader import AbstractFileReader\n\nPossible Exceptions\n~~~~~~~~~~~~~~~~~~~\n\n.. code:: python\n\n from read5.Exceptions import UnknownFileFormatException, UnknownNormalizationMode\n\n- UnknownFileFormatException: is raised, when the file extension does\n not match one of [\u2018.fast5\u2019, \u2018.pod5\u2019]\n- UnknownNormalizationMode: is raised, when an unknown mode is provided\n for the signal normalization function\n\nFull Documentation\n------------------\n\nCreated with `pdoc3 <https://pdoc3.github.io/pdoc/>`__. Can be found\n`here <https://jannessp.github.io/read5.github.io/>`__.\n",
"bugtrack_url": null,
"license": "GNU General Public License v3",
"summary": "Wrapper to read fast5 and pod5 files.",
"version": "1.2.5",
"project_urls": {
"Homepage": "https://github.com/JannesSP/read5"
},
"split_keywords": [
"read5",
" fast5",
" pod5",
" ont",
" oxford nanopore technologies",
" nanopore",
" raw data",
" wrapper"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f0026247a657c26e7e565f2118352011a8c45d409d732bd9c339b00822306ced",
"md5": "e4b09eba53552d30545e39c7a3b5c020",
"sha256": "24805c92da409b7ffff2769c3140e89441669ed1d225623584f1259f56dc9c41"
},
"downloads": -1,
"filename": "read5_ont-1.2.5-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "e4b09eba53552d30545e39c7a3b5c020",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 25083,
"upload_time": "2024-11-27T14:35:00",
"upload_time_iso_8601": "2024-11-27T14:35:00.637441Z",
"url": "https://files.pythonhosted.org/packages/f0/02/6247a657c26e7e565f2118352011a8c45d409d732bd9c339b00822306ced/read5_ont-1.2.5-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "55132702a1079e0af72ebb52fcc08645803178b7c49f92b89128e670435f993e",
"md5": "17595eda2135c8755682720e5d1d2a23",
"sha256": "d70f181a3fa3cda6ee9d1b5c5537365778867f254ce5dc887c9b41361cdc776e"
},
"downloads": -1,
"filename": "read5_ont-1.2.5.tar.gz",
"has_sig": false,
"md5_digest": "17595eda2135c8755682720e5d1d2a23",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 703292,
"upload_time": "2024-11-27T14:35:04",
"upload_time_iso_8601": "2024-11-27T14:35:04.359594Z",
"url": "https://files.pythonhosted.org/packages/55/13/2702a1079e0af72ebb52fcc08645803178b7c49f92b89128e670435f993e/read5_ont-1.2.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-27 14:35:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "JannesSP",
"github_project": "read5",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "read5-ont"
}
JSON
