Skip to content

README.md

Latest commit

 

History

History
131 lines (93 loc) · 3.96 KB

README.md

File metadata and controls

131 lines (93 loc) · 3.96 KB
Raw

MucOneUp

Python 3.10+ Tests Documentation Docker License: MIT DOI

MUC1 VNTR simulation and analysis toolkit for genomics research.

Overview

MucOneUp generates realistic MUC1 Variable Number Tandem Repeat (VNTR) sequences with customizable mutations and platform-specific sequencing reads. Designed for benchmarking variant callers, testing mutation detection pipelines, and generating synthetic training data.

Key Capabilities:

  • Diploid haplotype generation with probability-based repeat transitions
  • Frameshift mutation simulation (dupC, delC, custom insertions/deletions)
  • Multi-platform read simulation (Illumina, Oxford Nanopore, PacBio HiFi)
  • ORF prediction with toxic protein detection for ADTKD-MUC1 analysis
  • SNP integration and VNTR statistics analysis
  • Reproducible workflows with seed-based generation

Quick Start

# View help and version (no --config required)
muconeup -h        # Show help
muconeup -V        # Show version

# Generate diploid haplotypes with mutation
muconeup --config config.json simulate \
  --out-base sample \
  --mutation-name dupC \
  --mutation-targets 1,25

# Predict ORFs and detect toxic proteins
muconeup --config config.json analyze orfs \
  sample.001.simulated.fa \
  --out-base orfs

# Simulate Illumina reads
muconeup --config config.json reads illumina \
  sample.001.simulated.fa \
  --coverage 100

Documentation: https://berntpopp.github.io/MucOneUp/

Installation

Option 1: pip (Recommended for Users)

pip install git+https://github.com/berntpopp/MucOneUp.git

Requirements:

  • Python 3.10+
  • External tools for read simulation (optional): BWA, samtools, reseq

Option 2: Docker (All-in-One)

# Pull image
docker pull ghcr.io/berntpopp/muconeup/muconeup:latest

# Run
docker run --rm \
  -v $(pwd)/data:/data \
  -v $(pwd)/config.json:/app/config.json:ro \
  ghcr.io/berntpopp/muconeup/muconeup:latest \
  --config /app/config.json \
  simulate --out-base /data/sample

Includes: MucOneUp + Illumina (Wessim2-style + ReSeq) + ONT (NanoSim) + PacBio (pbsim3) - pre-configured environment.

Option 3: Development Setup

# Clone repository
git clone https://github.com/berntpopp/MucOneUp.git
cd MucOneUp

# Install with uv (modern Python package manager)
make init    # Install dev dependencies + pre-commit hooks
make test    # Run 568 tests
make check   # Verify installation

Citation

If you use MucOneUp in your research, please cite the archived release:

@software{muconeup_v0_44_4,
  author  = {Popp, Bernt},
  title   = {MucOneUp: MUC1 VNTR Simulation and Analysis Toolkit},
  version = {v0.44.4},
  year    = {2026},
  doi     = {10.5281/zenodo.19740406},
  url     = {https://doi.org/10.5281/zenodo.19740406}
}

Machine-readable metadata is available in CITATION.cff (GitHub's "Cite this repository" button generates formatted citations from it).

Status: Pre-release software under active development. A manuscript is in preparation.

License

MIT License - see LICENSE for details.

Maintained by: Bernt Popp