Wrapper to read fast5 and pod5 files.
Project description
Installation
Pypi/pip
pip install read5_ont
Conda
Pod5 is now available via conda (19.07.2023).
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 file.
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.
my_file can be a fast5 or pod5 file. The wrapper detects the file format depending on the file extension.
Small example:
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:
from read5.Fast5Reader import Fast5Reader # contains the Fast5 Reader class
from read5.Pod5Reader import Pod5Reader # contains the Pod5 Reader class
Abstract File Reader Class
from read5.AbstractFileReader import AbstractFileReader
Possible Exceptions
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
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for read5_ont-1.2.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b22ee51e07e0f88cbcab39007dc3b89dcf1c7cc80fa5eb05dc68562e141e7889 |
|
MD5 | bf32bc4286d3ce7db5723152eca68bc6 |
|
BLAKE2b-256 | 07113aa46a487d750a718ef9fc4a544ba97819cfdc3b45c90757924c805d4748 |