Skip to main content

A Tandem Repeats visualization tool for Decomposition of Motifs and Methylation across alleles.

Reason this release was yanked:

This release version contains incorrect decomposition logic & stale compiled assets. Do not use this release. Please upgrade to a higher version.

Project description

VisuaMiTRA - a Tandem Repeat Visualizer

Workflow

VisuaMiTRa

VisuaMiTRa (pronounced vi-shu-uh-mee-truh, IPA: /vɪʃuəmiːtrə/, Sanskrit: विश्वमित्र) is a specialized visualization tool for Tandem Repeat alleles, designed for a concise overview of motif decomposition, and corresponding epigenetic methylation signals. The name expands to VISUAlisation of Motifs & Methylation in Tandem Repeat Alleles.

The name is derived from the Sanskrit word Vishvamitra (विश्वमित्र), meaning "Friend of the Universe." In this context, VisuaMiTRa acts as a companion to the researcher, providing a clear comprehensive overview of tandem repeat complexity. By layering structural motifs and methylation data into a single, intuitive interface, it transforms dense genomic variant files into an accessible and navigable landscape.

Motivation

The high-resolution genotypes and methylation profiles generated by ATaRVa (v0.6.0) require an integrated perspective to be clearly interpreted. VisuaMiTRa is the essential next step, transforming VCF data outputs into a visual interface where structural motifs and epigenetic methylation signals align. Providing this overview enables researchers to rapidly validate and navigate ATaRVa's results at scale.

Table of Contents

Installation

VisuaMiTRa is available as a Python package that manages both the backend server and the compiled frontend automatically.

Prerequisites: Python 3.9+ and htslib (for Tabix functionality).

Create and activate a python environment (recommended)

source venv/bin/activate  # On Windows use: venv\Scripts\activate

Install the package

pip install visuamitra

Usage

Visuamitra v1.0.1 is compatible with ATaRVa v0.6.0

Browser mode

Once installed, to launch the tool and manually select or upload your VCF files via the web interface:

visuamitra

CLI Mode

Rather than browser upload, passing the vcf file path as argument will launch visuamitra.

visuamitra /path/to/your/file.vcf.gz

Note: The corresponding .tbi index file must reside in the same directory as the target .vcf.gz file, with same name (e.g., file.vcf.gz.tbi).

Access: The application will initialize and host the interface on port 8088. Open your web browser and navigate to http://localhost:8088.

Workflow

Workflow

Fig 1: Workflow of visuamitra

VisuaMiTRa uses a high-performance backend designed for rapid random access and minimal memory overhead.

Data Ingestion: Users provide a Tabix-indexed VCF file and its .tbi index (generated by ATaRVa).

Validation: FastAPI performs a preflight check using pysam to ensure the requested genomic region exists, preventing empty streams and invalid coordinate errors.

Pagination: To handle large data, the tool uses Base64-encoded cursors which allows to 'bookmark' positions and fetch subsequent pages without re-scanning entire files.

Optimized Streaming: Data is streamed in small chunks and delivered in real-time to ensure the tool remains fast and lightweight, even with very large files.

Reactive Visualization: React parses the TSV stream into an interactive SVG canvas, mapping structural motifs and methylation probabilities in real-time.

Workflow

Fig 2: Overview of visuamitra

✨ Features

VisuaMiTRa provides a comprehensive and intuitive overview of tandem repeat complexity.

👥 Multi-Sample Comparative Analysis (New in v1.0.0)

VisuaMiTRa now supports the simultaneous visualization of multiple samples from a merged VCF.

  • Dynamic Selection: Choose which samples to display using a searchable dropdown menu.

  • Synchronized Scaling: All selected samples are rendered on a shared genomic scale, allowing for direct visual comparison of allele lengths, motifs and methylation patterns across cohorts.

🧬 Dual View for Motifs & Methylation

  • VisuaMiTRa features independent tabs for motif decomposition & methylation that maintain strict allele-length consistency, enabling precise comparison across multiple samples.

📍 Effortless Navigation

  • Target specific loci using coordinate inputs (Chr, Start, End) or manually browse thousands of records smoothly, alongside an indicator with a track of genomic context in Chromosome. (Note: visuamitra v1.0.1 currently supports Hg38 reference only.)
Workflow

Fig 3: Location inputs

Workflow

Fig 4: Chromosome context

📏 Interactive Interface

  • Magnify in or out of intricate regions to ease data interpretation.

  • Hover over motif segments to instantly view repeat counts. Methylation levels markers for clearer visualisation.

  • Customize view with professional color palettes, scales & fonts.

Workflow

Fig 5: Repeat counts

Workflow

Fig 6: Methylation markers

💾 Download plots (New in v1.0.0)

  • Publication-Ready SVGs: Download high-resolution vector graphics of the viewed genomic locations.

  • Genomic plots could also be downloaded as PNG/JPGs.

Workflow

Fig 7: Download options

↑ Back to Top

Contacts

Authors: Siddharth K, Abishek Kumar, Divya Tej Sowpati

Email: Siddharth K - siddharthk at csirccmb dot org

Abishek Kumar S - abishekks at csirccmb dot org

Divya Tej Sowpati - tej at csirccmb dot org

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

visuamitra-1.0.2.tar.gz (3.1 MB view details)

Uploaded Source

Built Distribution

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

visuamitra-1.0.2-py3-none-any.whl (3.1 MB view details)

Uploaded Python 3

File details

Details for the file visuamitra-1.0.2.tar.gz.

File metadata

  • Download URL: visuamitra-1.0.2.tar.gz
  • Upload date:
  • Size: 3.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for visuamitra-1.0.2.tar.gz
Algorithm Hash digest
SHA256 db0b0d0c54392a7686c5b60e163808c3273cc65a4ef354dd56c4972fc29504ca
MD5 861bbbd6be828cf64c3c3ea15fb18d5e
BLAKE2b-256 a5bc658ff00222982cfc3f139ef2ad94347fae338c238936047937dc0bece7f8

See more details on using hashes here.

File details

Details for the file visuamitra-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: visuamitra-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 3.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for visuamitra-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0e028b601efec1fe702cab652437e21ce2e5aba08fbeae0428d80e47a3b1ec96
MD5 194c939fe2a5a30de9445c1b9b132a7a
BLAKE2b-256 4d7ea928af750647454f49151f1b555c0cf6f1819159a8482fc519ac76cb6d0d

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