Skip to main content

Capfinder - Advanced RNA Cap Type Prediction Framework

PyPI PyPi Downloads CI/CD PyPI - Python Version PyPI - License


Documentation: https://adnaniazi.github.io/capfinder

PyPI: https://pypi.org/project/capfinder/


Capfinder is a cutting-edge deep learning framework designed for accurate prediction of RNA cap types in mRNAs sequenced using Oxford Nanopore Technologies (ONT) SQK-RNA004 chemistry. By leveraging the power of native RNA sequencing data, Capfinder predicts the cap type on individual transcript molecules with high accuracy.

Key Features

  • Pre-trained Model: Ready-to-use classifier for immediate cap type prediction on ONT RNA-seq data.
  • Extensible Architecture: Advanced users can train the classifier on additional cap classes, allowing for customization and expansion.
  • Comprehensive ML Pipeline: Includes data preparation, hyperparameter tuning, and model training.
  • High Accuracy: State-of-the-art performance in distinguishing between various cap types.
  • Flexibility: Supports both CNN-LSTM, CNN-LSTML-Attention, ResNet, and Transformer-based Encoder model architectures.
  • Scalability: Designed to efficiently handle large-scale RNA sequencing datasets.

Supported Cap Types

Capfinder's pre-trained model offers accurate out-of-the-box predictions for the following RNA cap structures:

  1. Cap0: Unmodified cap structure
  2. Cap1: Methylated at the 2'-O position of the first nucleotide
  3. Cap2: Methylated at the 2'-O position of the first and second nucleotides
  4. Cap2,-1: Methylated at the 2'-O position of the first and second nucleotides, with an additional methylation at the -1 position

These cap types represent the most common modifications found in eukaryotic mRNAs. Capfinder's ability to distinguish between these structures enables researchers to gain valuable insights into RNA processing and regulation.

For advanced users, Capfinder's extensible architecture allows for training on additional cap types, expanding its capabilities to meet specific research needs.


Pre-requisite for using Capfinder

The mRNA for Capfinder analysis must be prepared as follows:

  1. Decap mRNA: Remove m7G from 5' end.

  2. Ligate the following 52-nt OTE sequence to 5' end:

    5'-GCUUUCGUUCGUCUCCGGACUUAUCGCACCACCUAUCCAUCAUCAGUACUGU-3'
    
  3. Sequence using ONT SQK-RNA004 chemistry.

These steps are crucial for accurate Capfinder predictions of mRNA cap types.

Installing Capfinder

First create and acitvate a new Python environment and then install Capfinder as following:

  1. For CPU

    pip install capfinder -U jax
    
  2. For GPU

    pip install capfinder -U "jax[cuda12]"
    
  3. For TPU

    pip install capfinder -U "jax[tpu]" -f https://storage.googleapis.com/jax-releases/libtpu_releases.html
    

Quick Start

The main command for cap type prediction is predict-cap-types:

capfinder predict-cap-types [OPTIONS]

Example usage:

capfinder predict-cap-types \
    --bam_filepath /path/to/sorted.bam \
    --pod5_dir /path/to/pod5_dir \
    --output_dir /path/to/output_dir \
    --n_cpus 100 \
    --dtype float16 \
    --batch_size 256 \
    --no_plot_signal \
    --no-debug \
    --no-refresh-cache

Documentation

Please read the Capfinder's comprehensive documentation for detailed information on using Capfinder.

License

Capfinder is released under the MIT License.

Want to Collaborate

Please contact Eivind D. Valen at University of Oslo.

Contributors

Capfinder's success and development would not have been possible without the efforts and contributions of the following people:

  1. Adnan Niazi
  2. Eivind Valen
  3. Maximillian Krause
  4. Jan Inge Øverbo
  5. Teshome Bizuayehu
  6. Kersti Nilsson

Metadata

Release files for capfinder 0.4.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for capfinder 0.4.3
File Size Uploaded Provenance Actions
capfinder-0.4.3.tar.gz 4.0 MB Without provenance Details for capfinder-0.4.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for capfinder 0.4.3
File Interpreter ABI Platform Actions
capfinder-0.4.3-py3-none-any.whl Python 3 none any Details for capfinder-0.4.3-py3-none-any.whl

Total release size: 7.9 MB

Release files / capfinder-0.4.3.tar.gz

Download URL capfinder-0.4.3.tar.gz
Size 4.0 MB
Tags Source
SHA-256 checksum
How to use checksums
43c09c0290b17955894e5d5d6cb483c57d086f886760a4d381d0d38b678b21da
BLAKE2b-256 checksum
How to use checksums
a6e11204caa3550a210b6caa531f7b54738c24476b3a8a41b9372f796343ba65
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.3 CPython/3.9.19 Linux/6.5.0-1025-azure

Release files / capfinder-0.4.3-py3-none-any.whl

Download URL capfinder-0.4.3-py3-none-any.whl
Size 4.0 MB
Tags Python 3
SHA-256 checksum
How to use checksums
026ef638675cc239da35c8d20c41aa8b41c8e5f333540717854f5ca88be0ee9f
BLAKE2b-256 checksum
How to use checksums
e0aa8077f5a05f54a8d951a49887f64ced257b8b6d68c264b438a3ef5e2e5751
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.3 CPython/3.9.19 Linux/6.5.0-1025-azure

Security for capfinder 0.4.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.4.3 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page