Skip to main content

View Bam in Highlighted HTML

Project description

DOI GitHub (Pre-)Release Date

Generate Highlighted HTML of Bam

highlight the specific sites of bam with samtools tview

Dependencies

  • Linux/Unix
  • Python2/Python3
  • samtools
  • tar/gzip/zip [optional for compressing]

Installation

pip install bam2html

Usage

bam2html -b <input.bam> chrom:pos           # single position
bam2html -b <input.bam> chrom:pos1,pos2...  # multiple positions
bam2html -b <input.bam> chrom:start-end     # a region of positions
bam2html -b <input.bam> chrom:pos -r /path/to/reference.fa # with reference
bam2html -b <input.bam> chrom:pos -c 300    # set the width of window
bam2html -b <input.bam> chrom:pos -color pink -bg green    # set colors
bam2html -bl bam_list pos_list                             # batch mode
bam2html -bl bam_list pos_list -s                          # generate summary.html
bam2html -bl bam_list pos_list -s -x zip                   # compress the result with zip
bam2html -bl bam_list pos_list -s -x tar.gz                # compress the result with tar/gzip

Example Results

Meaning of Base's Colors

Color Mapping Quality Selector
Blue 0-9 .tviewcu1
Green 10-19 .tviewc2
Yellow 20-29 .tviewc3
Black >=30 .tviewc4

Underline: Secondary or orphan


Documents

https://bam2html.readthedocs.io

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

bam2html-1.0.5.tar.gz (9.1 kB view hashes)

Uploaded Source

Supported by

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