Skip to main content

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.

Project description

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

Project details


Release history Release notifications | RSS feed

This version

0.2

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zither-0.2.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

zither-0.2-py2-none-any.whl (9.4 kB view details)

Uploaded Python 2

File details

Details for the file zither-0.2.tar.gz.

File metadata

  • Download URL: zither-0.2.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for zither-0.2.tar.gz
Algorithm Hash digest
SHA256 a998f6f330a70f10a99789619445bdc834314588bf3619d1e5fd0a72d2a6dd32
MD5 6263b1c32cb4f06c790617ec714180a4
BLAKE2b-256 813a1983b665386510955ea6f64bdf556c7d05d8a94e7708a432b0c0e8d2010f

See more details on using hashes here.

File details

Details for the file zither-0.2-py2-none-any.whl.

File metadata

File hashes

Hashes for zither-0.2-py2-none-any.whl
Algorithm Hash digest
SHA256 1bca324825a3f9d69a0645f9977665f4b6670d0149525d511359b1267c91b214
MD5 eb1f3667dc56d1ae5ac264c4f8d6bebe
BLAKE2b-256 b8a4822943e28171313b6d6bc4c7bc20b5f5f4744725c0d561f91de0838a308d

See more details on using hashes here.

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