Package for predicting 5EU in nanopore reads and predicting RNA halflives
Project description
RNAkinet
RNAkinet is a project dedicated to detecting 5eu-modified reads directly from the raw nanopore sequencing signal. Furthermore, it offers tools to calculate transcript halflives.
Usage
Installation
pip install rnakinet
Predict 5EU in your fast5 files
rnakinet-inference --path <path_to_folder_containing_fast5s> --output <predictions_name.csv>
This creates a csv file with columns read_id
- the read id, 5eu_mod_score
- the raw prediction score from 0 to 1, 5eu_modified_prediction
- Boolean column, True if the read is predicted to be modified by 5EU, False otherwise
Nvidia GPU is recommended to run this command. If you want to run inference on a CPU-only machine, use the --use-cpu
option. This will substantially increase runtime.
Example
rnakinet-inference --path data/experiment/fast5_folder --output preds.csv
R9 and R10 kits
RNAkinet can be run on fast5 files produced by nanopore R9 and R10 kits. You can specify your kit using the --kit
option. Note that the R10 version is a work in progress.
rnakinet-inference --path data/experiment/fast5_folder --kit r10 --output preds.csv
Calculate transcript halflives
rnakinet-predict-halflives --transcriptome-bam <path_to_transcriptome_alignment.bam> --predictions <predictions_name.csv> --tl <experiment_tl> --output <halflives_name.csv>
The --tl
parameter is the duration for which the cells were exposed to 5EU in hours
The --predictions
parameter is the output file of the 5EU prediction step described above
This creates a csv file with columns transcript
- the transcript identifier from your BAM file, reads
- the amount of reads available for the given transcript, percentage_modified
- the percentage of reads of the given transcript that were predicted to contain 5EU, pred_t5
- the predicted halflife of the given transcript
Example
rnakinet-predict-halflives --transcriptome-bam alignments/experiment/transcriptome_alignment.bam --predictions preds.csv --tl 2.0 --output halflives.csv
Note that the calculated halflives pred_t5
are the most reliable for transcripts with high read count.
The following plots show correlation of halflives computed from RNAkinet predictions with experimentaly measured halflives [1] as we increase read count requirement.
We recommend users to acknowledge this and put more confidence in halflife predictions for transcripts with high read count, and less confidence for transcripts with low read count.
[1] Eisen,T.J., Eichhorn,S.W., Subtelny,A.O., Lin,K.S., McGeary,S.E., Gupta,S. and Bartel,D.P. (2020) The Dynamics of Cytoplasmic mRNA Metabolism. Mol. Cell, 77, 786-799.e10.
Project details
Release history Release notifications | RSS feed
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
File details
Details for the file rnakinet-1.0.0.tar.gz
.
File metadata
- Download URL: rnakinet-1.0.0.tar.gz
- Upload date:
- Size: 1.3 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.12.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ef34b62b9b0baecd030791e3bd8f9e2d3da29aedbf34b5c454e9b68d8d44686e |
|
MD5 | b95273c6834a4e34635bc463bcb31aa9 |
|
BLAKE2b-256 | 7b71e1f49510fab5ec09380f8adc15139bedc17c7710624f6e90202992533120 |
File details
Details for the file rnakinet-1.0.0-py3-none-any.whl
.
File metadata
- Download URL: rnakinet-1.0.0-py3-none-any.whl
- Upload date:
- Size: 1.3 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.12.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 597a94da50f1e19b9f427ecce22e7b594bdd4a8e3bbbfd6df2541a46e1823aef |
|
MD5 | 61391f6088ae1c12cd494a591bcc18f9 |
|
BLAKE2b-256 | 494be465a8464a8dc38a3857d56f3c65e73618154b7801818156d2484914beb8 |