Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 1.15 KB

README.md

File metadata and controls

44 lines (30 loc) · 1.15 KB

CI

vcztools

Partial reimplementation of bcftools for VCF Zarr

Please see the preprint for more information.

Installation

python3 -m pip install vcztools

Usage

vcztools view <path.vcz>

or

python -m vcztools view <path.vcz>

should be equivalent to running

bcftools view <path.vcf.gz>

See the bio2zarr project for help in converting VCF files to Zarr.

Goals

Vcztools aims to be a drop-in replacement for a subset of bcftools functionality. Currently supported are the view, query and index -s/-n commands.

We aim for 100% compatibility so if you notice a difference between the output of vcztools and bcftools please do open an issue.

Development

Vcztools is under active development and contributions are warmly welcomed. Please see the project on GitHub.