Skip to main content

Framework for the analysis of long read transcriptome sequencing data

Project description

tests docs PyPI PyPIDownloadsTotal Licence: MIT IsoTools Logo

IsoTools

IsoTools is a python module for Long Read Transcriptome Sequencing (LRTS) analysis.

Key features:

  • Import of LRTS bam files (aligned full length transcripts).
  • Import of reference annotation in gff3/gtf format.
  • Computation of quality control metrics.
  • Annotation and classification of novel transcripts using the biologically motivated classification scheme SQANTI.
  • Evaluation of the coding potential of isoforms.
  • Definition of alternative splicing events based on segment graphs.
  • Detection of differential alternative splicing between samples and groups of samples.
  • Gene modelling based on structural and expression variability.
  • Support for proteogenomic approaches at the interface of transcriptomics and proteomics.
  • Various data visualizations.

Documentation

The documentation, including tutorials with real-world case studies and the complete API reference is available at readthedocs

Installation

Isotools is available from PyPI, and can be installed with the pip command:

python3 -m pip install isotools

Alternatively, to install from github, use the following command:

git clone https://github.com/HerwigLab/IsoTools2.git
cd isotools
python3 -m pip install .

Usage

This code block demonstrates the basic file import with IsoTools. It uses a small test data set contained in this repository, and should run within seconds. The paths are relative to the root of the repository. For more comprehensive real world examples see the tutorials.

from isotools import Transcriptome
import logging
logging.basicConfig(format='%(levelname)s:%(message)s', level=logging.INFO)
# import the reference annotation
transcriptome = Transcriptome.from_reference('tests/data/example.gff.gz')
# import the transcriptome data
for sa in ('CTL', 'VPA'):
    transcriptome.add_sample_from_bam(f'../tests/data/example_1_{sa}.bam', sample_name=sa, group=sa, platform='SequelII')
# save the imported file as pkl file (for faster import)
transcriptome.add_qc_metrics('../tests/data/example.fa')
transcriptome.save('../tests/data/example_1_isotools.pkl')

Citation and feedback

  • If you run into any issues, please use the github issues report feature.
  • For general feedback, please write us an email to yalan_bi@molgen.mpg.de and herwig@molgen.mpg.de.
  • If you use IsoTools in your publication, please cite the following paper in addition to this repository:
    • Lienhard, Matthias et al. “IsoTools: a flexible workflow for long-read transcriptome sequencing analysis.” Bioinformatics (Oxford, England) vol. 39,6 (2023): btad364. doi:10.1093/bioinformatics/btad364
    • Bi, Yalan et al. “IsoTools 2.0: Software for Comprehensive Analysis of Long-read Transcriptome Sequencing Data.” Journal of molecular biology, 169049. 26 Feb. 2025, doi:10.1016/j.jmb.2025.169049

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

isotools-2.0.0.tar.gz (131.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

isotools-2.0.0-py3-none-any.whl (132.0 kB view details)

Uploaded Python 3

File details

Details for the file isotools-2.0.0.tar.gz.

File metadata

  • Download URL: isotools-2.0.0.tar.gz
  • Upload date:
  • Size: 131.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for isotools-2.0.0.tar.gz
Algorithm Hash digest
SHA256 897467286f8ad1b51e843692a6e045250c49dee0c40dc4ccf6329962189e5bfc
MD5 c134883735fad61842c40191e1a23973
BLAKE2b-256 c4a3dd0538c22f5840012e604ae1d7c2fbb937c3940e34fb72dee6f1a0823073

See more details on using hashes here.

File details

Details for the file isotools-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: isotools-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 132.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for isotools-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5093104cd4179c757fc8bfcbf827cb561c898a0f9050f0558f26e82cf10274f3
MD5 fb0312eee5809a0c44602e2e19101713
BLAKE2b-256 95df94c4a2819143140ff83b7f29192324ab4f54d38f39626eaf4a19e83c12e7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page