Skip to main content

Zither

Command-line tool to pull raw depths and alt freqs from BAM file(s) based on an existing VCF, writing output as new VCF to stdout.

Build Status Coverage Status

The official repository is at:

https://github.com/umich-brcf-bioinf/Zither

Quickstart

Read a single BAM file

$ zither –bam examples/explicit_bam/Sample_X.bam examples/explicit_bam/input.vcf > output.vcf

Given a VCF and a BAM file, read positions in the input VCF and corresponding pileups from Sample_X.bam.

Read a set of matched VCF sample names and BAM files

$ zither examples/matching_names/input.vcf > output.vcf

Given a VCF and a collection of BAM files whose file names match the VCF sample names, reads positions from the input VCF and corresponding BAM pileups.

Explicitly map VCF sample names to BAM files

$ zither –mapping_file=examples/mapping_files/mapping_file.txt examples/mapping_files/input.vcf > output.vcf

Given a VCF, a collection of BAMs, and a file that maps sample names to BAM paths, reads positions from the input VCF and corresponding pileups from BAM files names.

The mapping file is a tab-separated text file where each line has a sample name and the path to the corresponding BAM file. Paths to BAM files can be absolute or relative; relative paths are resolved relative to the directory that contains the mapping file.


Email bfx-zither@umich.edu for support and questions.

UM BRCF Bioinformatics Core

Changelog

0.2 (9/3/2015)

  • Adjusted tags to include total and unfiltered depth and alt freq.

  • Added basecall quality filtering

  • Added depth cutoff

  • Added support for Python3

0.1 (8/6/2015)

Initial Release

Zither is written and maintained by the University of Michigan BRCF Bioinformatic Core; individual contributors include:

  • Chris Gates

  • Divya Kriti

Metadata

Release files for zither 0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for zither 0.2
File Size Uploaded
zither-0.2.tar.gz 7.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for zither 0.2
File Interpreter ABI Platform
zither-0.2-py2-none-any.whl Python 2 none any Details

Total release size: 16.9 kB

Release files / zither-0.2.tar.gz

Download URL zither-0.2.tar.gz
Size 7.5 kB
Tags Source
SHA-256 checksum
How to use checksums
a998f6f330a70f10a99789619445bdc834314588bf3619d1e5fd0a72d2a6dd32
BLAKE2b-256 checksum
How to use checksums
813a1983b665386510955ea6f64bdf556c7d05d8a94e7708a432b0c0e8d2010f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / zither-0.2-py2-none-any.whl

Download URL zither-0.2-py2-none-any.whl
Size 9.4 kB
Tags Python 2
SHA-256 checksum
How to use checksums
1bca324825a3f9d69a0645f9977665f4b6670d0149525d511359b1267c91b214
BLAKE2b-256 checksum
How to use checksums
b8a4822943e28171313b6d6bc4c7bc20b5f5f4744725c0d561f91de0838a308d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.2 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page