Install vcflib with Homebrew

Project links

• Homepage
• Upstream docs
• Package manager page

Commands and aliases

• abba-baba
• bFst
• bed2region
• bgziptabix
• dumpContigsFromHeader
• genotypeSummary
• hapLrt
• iHS
• meltEHH
• normalize-iHS
• pFst
• pVst
• permuteGPAT++
• permuteSmooth
• plotHaps
• popStats
• segmentFst
• segmentIhs
• sequenceDiversity
• smoother
• vcf2bed.py
• vcf2dag
• vcf2fasta
• vcf2sqlite.py
• vcf2tsv
• vcf_strip_extra_headers
• vcfaddinfo
• vcfafpath
• vcfallelicprimitives
• vcfaltcount
• vcfannotate
• vcfannotategenotypes

Project history

The vcflib README presents VCF as the de facto reporting format for many genomic variant detectors and describes vcflib as an API plus a command-line utility collection for complex VCF manipulation. The project originated with Erik Garrison and later became part of a broader vcflib organization containing related VCF tools.

In 2022, Garrison, Kronenberg, Dawson, Pedersen, and Prins published a PLOS Computational Biology software paper covering vcflib, bio-vcf, cyvcf2, hts-nim, and slivar. The paper describes more than 125 free and open-source tools and libraries for VCF processing, with vcflib providing performance-oriented C++ tools and a reusable API.

Adoption history

The 2022 PLOS paper states that VCF has been widely adopted since 2011 in population studies and somatic and germline mutation studies, and that the authors' tools run in critical biomedical pipelines and many shell scripts. That is the adoption setting in which vcflib matters: it is a toolbox for the messy middle of sequencing workflows.

The project has seen packaging and maintenance transitions common to mature bioinformatics software. GitHub releases show a 1.0 release in September 2019, a Python 3 transition around 2019, and continued 1.x releases into the 2020s.

How it is used

vcflib tools are designed to be composed in streaming pipelines. The README explicitly encourages using Unix pipes to interface with VCFtools, BEDTools, GATK, HTSlib, bio-vcf, bcftools, and FreeBayes while avoiding unnecessary intermediate files.

Typical commands cover filtering, set operations, left-aligning indels, decomposing or merging alleles, checking reference consistency, generating statistics, population-genetics metrics, converting VCF to other representations, and annotating records from BED or genotype information.

Why package nerds care

vcflib is package-nerd significant because it is a bag of sharp, small bioinformatics commands rather than one monolithic analysis application. Installing it adds dozens of executables whose names encode the workflow vocabulary of VCF-heavy pipelines.

It also captures a real packaging challenge in scientific software: one project ships C++ utilities, scripts, Python bindings, and library headers, and users expect it to compose with a wider command-line genomics stack across Linux, macOS, containers, and workflow systems.

Timeline

• 2011: VCF is introduced and described with VCFtools, establishing the ecosystem vcflib later serves.
• 2016-02-08: vcflib v1.0.0-rc1 appears in GitHub releases.
• 2019-09-03: vcflib v1.0.0 is released.
• 2022-05-31: The PLOS Computational Biology software paper on vcflib and related VCF tools is published.
• 2023: vcflib 1.0.x maintenance releases continue on GitHub.

Related projects

• VCFtools is the older VCF suite and standard paper that established much of the file-format context.
• bio-vcf, cyvcf2, hts-nim, and slivar are discussed with vcflib in the 2022 software paper as complementary tools for VCF processing.
• FreeBayes is a related variant caller and companion project in the VCF ecosystem.
• BEDTools, HTSlib, bcftools, GATK, and tabix-indexed workflows are common neighbors in pipelines that use vcflib.

Sources

• https://api.github.com/repos/vcflib/vcflib/releases
• https://github.com/vcflib/vcflib
• https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1009123