Command-line tools to expedite analysis of Variant Call Format (VCF) files.
Project description
Suite of command-line tools to expedite analysis of exome variant data from multiple patients and multiple variant callers.
The official repository is at:
https://github.com/umich-brcf-bioinf/Jacquard
Usage
$ jacquard <subcommand> [options] [arguments]
Subcommands
- translate:
Creates new VCFs, adding a controlled vocabulary of new FORMAT tags.
- merge:
Integrates a directory of VCFs into a single VCF.
- summarize:
Adds new INFO fields and FORMAT tags that combine variant data from the merged VCF.
- expand:
Explodes a VCF file into a tab-delimited file.
For help on a specific subcommand:
$ jacquard <subcommand> --help
See ReadTheDocs for full documentation.
Email bfx-jacquard@umich.edu for support and questions.
UM BRCF Bioinformatics Core
Installing Jaquard
Jacquard has been tested with Python 2.7 and 3.4 on Windows7, OSX, and *nix.
Prerequisites
natsort (3.5.2)
nosetests, testfixtures (3.0.2), and numpy (>=1.7.1) are required for running automated tests
Installing
The easiest way to install Jacquard is through PyPI. Get pip if it’s not available in your system:
$ pip install jacquard
You can install from source from github:
$ pip install git+https://github.com/umich-brcf-bioinf/Jacquard
If you don’t have root permissions, you can install locally:
$ pip install --user jacquard
Changelog
0.42 (X/X/XXXX)
Added docs on readthedocs.
Improved workflow documentation with example data
Merge will now disambiguate tag collisions from multiple VCs
Translate/summarize now supports GT tags
Extended precision to 4 decimal places to support analysis of gene-panels.
Adjusted translate to handle empty high-confidence VarScan files.
0.41 (5/7/2015)
Combined filter command with merge command
Extended expand to create simple metaheader glossary
Adjusted code to support Python >=2.7 or 3.x
Improved checks for consistent VCF file sets
Fixed bug in merge that caused error if any VCFs were unsorted
Fixed bug in summarize that caused error if variant was called by subset of callers
0.31 (3/17/2015)
Downgraded VCF format from 4.2 to 4.1
Fixed a bug that omitted CALLERS_REPORTED_LIST summary tag
Simplified summary tags; removed dependency on numpy
Adjusted VarScan translation to accept a file pattern to identify high-confidence files
0.3 (3/9/2015)
Replaced normalize, tag commands with translate; relaxed constraints on incoming data.
Renamed consensus to summarize
More consistent behavior in expand
Significantly improved merge performance
Added new summary tags: - CALLERS_REPORTED_COUNT - CALLERS_REPORTED_LIST - SAMPLES_REPORTED_COUNT - CALLERS_PASSED_COUNT - CALLERS_PASSED_LIST - SAMPLES_PASSED_COUNT
Fixed bug in how Strelka calculated AF on indels
Improved command validation and error handling
Added project/code documentation
Removed dependencies on pandas
0.21 (10/2014)
Initial public release
Jacquard is written and maintained by the University of Michigan BRCF Bioinformatic Core; individual contributors include:
Jessica Bene
Ashwini Bhasi
Chris Gates
Divya Kriti
Kevin Meng
Peter Ulintz
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for jacquard-0.42-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 65ea3b35f939929ba509fe06398b1859006f78754a4fb83e8e8b53706e55707c |
|
MD5 | c10d572aa7d271dba1a737e8e69bd20e |
|
BLAKE2b-256 | 591625e2c56a463aaed5403b2fc67042b638130d1bf15572f926e2d8f2df2e72 |