wally

Wally: Visualization of aligned sequencing reads and contigs

https://github.com/tobiasrausch/wally

Science Score: 49.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
  • Committers with academic emails
    1 of 2 committers (50.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.7%) to scientific vocabulary

Keywords

alignment assembly contigs genomics mapping plotting sequencing sequencing-data visualization
Last synced: 6 months ago · JSON representation

Repository

Wally: Visualization of aligned sequencing reads and contigs

Basic Info
Statistics
  • Stars: 115
  • Watchers: 2
  • Forks: 6
  • Open Issues: 4
  • Releases: 13
Topics
alignment assembly contigs genomics mapping plotting sequencing sequencing-data visualization
Created over 4 years ago · Last pushed 10 months ago
Metadata Files
Readme License Authors Zenodo

README.md

install with bioconda Anaconda-Server Badge C/C++ CI Docker CI GitHub license GitHub Releases

Wally

Plotting of aligned sequencing reads, assembled contigs or pan-genome graphs in BAM/CRAM format and visualization of genomic variants.

Installing Wally

Wally is available as a Bioconda package, as a pre-compiled static binary from the release page, as a singularity container SIF file or as a minimal Docker container. You can also build Wally from source using a recursive clone and make.

git clone --recursive https://github.com/tobiasrausch/wally.git

cd wally/

make all

Running Wally

Wally uses subcommands for different visualization modes.

Subcommand region: Visualization of alignment regions

Wally needs a sorted and indexed BAM/CRAM file and a reference genome. The output is a genomic alignment plot of the region specified on the command-line.

wally region -r chrA:35-80 -g <genome> <input.bam>

You can specify a plot name using another colon separator

wally region -r chrA:35-80:myplot -g <genome> <input.bam>

Most often you probably want to use a BED file with regions of interest and just execute wally in batch. The 4-th column specifies the plot name. For instance to plot variants from a VCF file you can use:

bcftools query -f "%CHROM\t%POS\n" <input.vcf.gz> | awk '{print $1"\t"($2-50)"\t"($2+50)"\tid"NR;}' > regions.bed

wally region -R regions.bed -g <genome> <input.bam>

Gene annotations

Simple BED files are used to provide gene or other annotations. The BED file needs to be bgzipped and indexed via tabix (tabix -p bed input.bed.gz). The required columns are chromosome, start, end and an identifier which is displayed if there is sufficient space.

wally region -b bed/gencode.hg19.bed.gz -r chr17:7573900-7574000 -g <genome> <input.bam>

The chromosome names of the genome FASTA file, BAM file and BED annotation file need to match, "chr11" and "11" are not considered identical.

Custom colors for BED file annotations

You can specify custom colors for each annotation record in the BED file using Hex color codes (column 5 of the BED file). For instance, an annotation file anno.bed with this content:

chr17 7350100 7350900 regRed 0xFF0000 chr17 7351100 7351900 regLime 0x00FF00 chr17 7352100 7352900 regBlue 0x0000FF chr17 7353100 7353900 regTeal 0x008080

can be visualized using

bgzip anno.bed

tabix -p bed anno.bed.gz

wally region -b anno.bed.gz -r chr17:7350000-7354000 -g <genome> <input.bam>

Multiple BAM files

You can include multiple BAM files in a plot such as a tumor genome and a matched control in cancer genomics.

wally region -r chr17:7573900-7574000 -g <genome> <tumor.bam> <control.bam>

In fact, wally can be used to create "wallpapers" of genomes which gave rise to the tool name. For instance, the below command can be used to create a full genome view of 96 samples of a full plate of SARS-CoV-2 genomes.

wally region -y 20480 -r NC_045512.2:1-30000 -g NC_045512.2.fa Plate*.bam

Aligning multiple regions horizontally (split view)

Wally allows concatenating images of different regions horizontally using the --split option. This can be used, for instance, to zoom into a specific variant. On the command line the regions need to be separated by , without spaces. As an example, you can zoom into the N501Y variant of the alpha SARS-CoV-2 lineage using

wally region -s 3 -x 2048 -r NC_045512.2:22000-24000,NC_045512.2:23000-23100,NC_045512.2:23050-23070 -g NC_045512.2.fa <input.bam>

You can split horizontally and vertically at the same time to view, for instance, a somatic inter-chromosomal translocation.

wally region -s 2 -r chrA:35-80,chrB:60-80 -g <genome> <tumor.bam> <control.bam>

If you specify the regions in a BED file using the -R option then the split parameter operates row-wise, e.g., for -s 3 row 1-3 of the BED file make up the first image, row 4-6 the second image, and so on.

Paired-end view

With -p you can switch on the paired-end view.

wally region -p -r chrA:35-80 -g <genome> <input.bam>

The paired-end coloring highlights candidate structural variants supported by read1 (R1) and read2 (R2). Below is a mapping of delly's structural variant types to wally's paired-end coloring. For inter-chromosomal translocations I assumed for this illustration that R1 maps to chromosome A and R2 maps to chromosome B.

  • #3fafaf inversion-type paired-end, --R1--> --R2-->, INV:3to3
  • #4e64d5 inversion-type paired-end, <--R1-- <--R2--, INV:5to5
  • #d53f3f deletion-type paired-end, --R1--> <--R2--, DEL:3to5
  • #3faf3f duplication-type paired-end, <--R1-- --R2-->, DUP:5to3
  • #fb9a99 inter-chr paired-end, A:--R1--> B:--R2--> leads to --A--> <--B-- junction, BND:3to3
  • #fdbf6f inter-chr paired-end, A:<--R1-- B:<--R2-- leads to <--A-- --B--> junction, BND:5to5
  • #ff8000 inter-chr paired-end, A:--R1--> B:<--R2-- leads to --A--> --B--> junction, BND:3to5
  • #cab2d6 inter-chr paired-end, A:<--R1-- B:--R2--> leads to <--A-- <--B-- junction, BND:5to3

For large and complex structural variants, wally supports split views (as explained above). For instance, for an inter-chromosomal translocation you probably want to use a 2-way horizontal split with a larger image size.

wally region -p -x 2048 -y 2048 -s 2 -r chrA:35-80,chrB:60-80 -g <genome> <tumor.bam> <control.bam>

To visualize genomic breakpoints it's also helpful to highlight clipped reads -c and supplementary alignments -u.

wally region -cup -x 2048 -y 2048 -s 2 -r chrA:35-80,chrB:60-80 -g <genome> <tumor.bam> <control.bam>

Subcommand matches: Visualization of chained alignment matches

For long read alignments or mappings of entire contigs, one often wants to explore all matches of a long input sequence with respect to the reference to visualize, for instance, complex rearrangements. For a single read or contig, you need a sorted and indexed BAM file and the reference genome.

wally matches -r <read_name> -g <genome> <input.bam>

Forward matches are colored in blue, reverse matches in orange and the black line traces all alignment matches along the input read sequence. You can also plot multiple reads to inspect, for instance, alignment concordance or heterogeneity using a list of reads as an input file.

wally matches -R <read.lst> -g <genome> <input.bam>

For many reads, this quickly leads to "wall(y)papers". With -p you get a separate plot for each read.

wally matches -p -R <read.lst> -g <genome> <input.bam>

You can also compare assemblies or align contigs to a reference genome using a workflow like this:

minimap2 -ax asm5 ref.fa asm.fa | samtools sort -o assembly.bam -

samtools index assembly.bam

wally matches -r <contig_name> -g ref.fa assembly.bam

Subcommand dotplot: Pairwise sequence dotplots

All pairwise dotplots of a FASTA file can be generated using

wally dotplot sequences.fa

You can also extract reads directly from the BAM file and generate a reference-independent dotplot that includes the genomic mapping locations of read segments.

wally dotplot -R reads -g hg38.fa input.bam

For instance, to inspect haplotype differences or tumor heterogeneity at a given genomic locus (e.g., chrA:1000-2000) one can use:

samtools view input.bam chrA:1000-2000 | cut -f 1 | sort | uniq > reads

wally dotplot -R reads -g hg38.fa input.bam

Instead of plotting reads in pairs against each other, you can also calculate dot plots with respect to reference regions.

wally dotplot -g hg38.fa -R reads -e chrA:35000-80000 input.bam

wally dotplot -g hg38.fa -e chrA:35000-80000 sequences.fa

A minimum contig or read length can be specified using -s

wally dotplot -s 10000 -R reads -g hg38.fa input.bam

Lastly, you can flatten the genomic mappings into simple blocks using -f

wally dotplot -f -s 10000 -R reads -g hg38.fa input.bam

To visualize a self-alignment of a read with reference mappings use -a

wally dotplot -a -r read_name -g hg38.fa input.bam

Web application

You can try wally on some selected data sets using the wally web application.

Citation

Tobias Rausch, Rene Snajder, Adrien Leger, Milena Simovic, Mădălina Giurgiu, Laura Villacorta, Anton G. Henssen, Stefan Fröhling, Oliver Stegle, Ewan Birney, Marc Jan Bonder, Aurelie Ernst, Jan O. Korbel
Long-read sequencing of diagnosis and post-therapy medulloblastoma reveals complex rearrangement patterns and epigenetic signatures
Cell Genomics, 2023, 100281, DOI: 10.1016/j.xgen.2023.100281

License

Wally is distributed under the BSD 3-Clause license. Consult the accompanying LICENSE file for more details.

Credits

Wally relies heavily on the HTSlib and OpenCV. The visualization of genomic alignments was heavily inspired by IGV.

Owner

  • Name: Tobias Rausch
  • Login: tobiasrausch
  • Kind: user
  • Location: Germany
  • Company: EMBL

Researcher in Computational Genomics

GitHub Events

Total
  • Create event: 1
  • Release event: 1
  • Issues event: 8
  • Watch event: 11
  • Issue comment event: 12
  • Push event: 2
Last Year
  • Create event: 1
  • Release event: 1
  • Issues event: 8
  • Watch event: 11
  • Issue comment event: 12
  • Push event: 2

Committers

Last synced: over 1 year ago

All Time
  • Total Commits: 242
  • Total Committers: 2
  • Avg Commits per committer: 121.0
  • Development Distribution Score (DDS): 0.017
Past Year
  • Commits: 26
  • Committers: 1
  • Avg Commits per committer: 26.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
tobiasrausch r****i@g****m 238
Tobias Rausch r****h@e****e 4
Committer Domains (Top 20 + Academic)
embl.de: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 15
  • Total pull requests: 0
  • Average time to close issues: about 1 month
  • Average time to close pull requests: N/A
  • Total issue authors: 10
  • Total pull request authors: 0
  • Average comments per issue: 2.6
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 5
  • Pull requests: 0
  • Average time to close issues: 1 day
  • Average time to close pull requests: N/A
  • Issue authors: 4
  • Pull request authors: 0
  • Average comments per issue: 2.8
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • baozg (3)
  • MJoseMo (2)
  • ralonso-igenomix (2)
  • dridk (1)
  • Venkatesh-99 (1)
  • jgarces02 (1)
  • min-codes (1)
  • ylevmirom (1)
  • davidebolo1993 (1)
Pull Request Authors
Top Labels
Issue Labels
question (2) enhancement (2) bug (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 16
proxy.golang.org: github.com/tobiasrausch/wally
  • Versions: 16
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.5%
Average: 5.7%
Dependent repos count: 5.8%
Last synced: 6 months ago

Dependencies

.github/workflows/c-cpp.yml actions
  • actions/checkout v2 composite
.github/workflows/docker.yml actions
  • docker/build-push-action v2 composite
  • docker/login-action v1 composite
  • docker/setup-buildx-action v1 composite
  • docker/setup-qemu-action v1 composite
.github/workflows/macosx.yml actions
  • actions/checkout v2 composite
Dockerfile docker
  • alpine latest build
  • ubuntu 22.04 build
.github/workflows/release.yml actions
  • actions/checkout v4 composite
  • docker/build-push-action 3b5e8027fcad23fda98b2e3ac259d8d67585f671 composite
  • docker/login-action f4ef78c080cd8ba55a85445d5b36e214a81df20a composite
  • docker/metadata-action 9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7 composite