Skip to main content

Plot Oxford Nanopore variation as self-contained HTML reports.

Project description

                 _                       _              .--.
 _ __ ___   ___ | | __ _ _ __ ___   ___ | | __ _      _/    \___
| '_ ` _ \ / _ \| |/ _` | '_ ` _ \ / _ \| |/ _` |    ( o        )
| | | | | | (_) | | (_| | | | | | | (_) | | (_| |     \___..___/
|_| |_| |_|\___/|_|\__,_|_| |_| |_|\___/|_|\__,_|         ||

A Python plotting tool for Oxford Nanopore variation data. One VCF in, one self-contained HTML report out. molamola inspects the VCF header and picks between an SV / cytogenetics report (long-read SV VCFs from Sniffles2 / cuteSV / SVIM / pbsv / NanoVar) and per-gene phased-haplotype panels (phased + VEP-annotated small-variant VCFs from WhatsHap / HiPhase). Figures embedded as base64 PNGs — no external assets, opens offline.

Full documentation: https://martinandclaude.github.io/molamola/

Install

pip install molamola

Or via conda — note that both bioconda and conda-forge channels are needed (pycirclize lives on conda-forge):

conda create -n molamola -c bioconda -c conda-forge molamola

Or for development from a clone:

git clone https://github.com/martinandclaude/molamola.git
cd molamola
pip install -e .[dev]
pytest -v

Quick start

# Long-read SV VCF (Sniffles2 etc.) → cytogenetics report
molamola --vcf sample.sniffles.vcf
open path/to/sample.report.html

# Phased + VEP-annotated VCF → compound-het workup, all candidate genes
molamola --vcf sample.phased.vep.vcf.gz
open path/to/sample.compound_het.report.html

# Just one gene from a phased + VEP VCF
molamola --vcf sample.phased.vep.vcf.gz --gene NEB

The plot type is auto-detected from the VCF header: ##INFO=<ID=SVTYPE> selects SV mode; ##INFO=<ID=CSQ> + ##FORMAT=<ID=PS> selects compound-het mode. VCFs that match neither shape are refused with a clear error.

See the docs for example output, VEP annotation prep, the full CLI reference, filter explanations, and worked examples.

Acknowledgements

License

MIT.

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

molamola-0.2.0.tar.gz (14.8 MB view details)

Uploaded Source

Built Distribution

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

molamola-0.2.0-py3-none-any.whl (14.8 MB view details)

Uploaded Python 3

File details

Details for the file molamola-0.2.0.tar.gz.

File metadata

  • Download URL: molamola-0.2.0.tar.gz
  • Upload date:
  • Size: 14.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.2

File hashes

Hashes for molamola-0.2.0.tar.gz
Algorithm Hash digest
SHA256 6653ec0f5dd1719111491442f3b9b17a40ad1ad4adcb4df36be783e9cdbcd37e
MD5 f4646a292152e94fd204c57eaa8b73e0
BLAKE2b-256 50a3826cf7913c28817a466d81378665e57d5fdae3bf3a70f87e7979dedd0586

See more details on using hashes here.

File details

Details for the file molamola-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: molamola-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 14.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.2

File hashes

Hashes for molamola-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 94de5b7593db8a0d85a5cdc49c6382d9729c247b28c6dcfe39028e08ac3b486e
MD5 ee267648e125267436b0ac99e7e86aee
BLAKE2b-256 273cec0490a9a3ee6ad693e2f631da731a918effc53858bdb2ad96ba92758c72

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