vArmyKnife

Variant Army Knife

vArmyKnife

Version3.3.90 (Updated Mon Jul 3 09:37:25 EDT 2023)

(back to help base)

General Help

DESCRIPTION:

NOTE: if you run into OutOfMemoryExceptions, try adding the java options: "-Xmx8G"

GENERAL SYNTAX:

varmyknife [java_options]  [options] infile outfile
OR
varmyknife [java_options]  [options] infile - > outfile
OR
varmyknife [java_options] --CMD commandName [options]

COMMANDS:

walkVcf

This utility performs a series of transformations on an input VCF file and adds an array of informative tags.

VcfToMatrix

UNTESTED ALPHA: FOR DEVELOPMENT/TESTING PURPOSES ONLY! DO NOT USE!

splitExomeIntoParts

UNTESTED ALPHA: FOR DEVELOPMENT/TESTING PURPOSES ONLY! DO NOT USE!

EXPERIMENTAL COMMANDS:

These commands have not been fully tested and are not for production use. Documentation may be incomplete or nonexistant. Some are nonfunctional, or have been subsumed into other commands, or were only intended for internal testing purposes. Use at your own risk!

GenerateTranscriptAnnotation

This utility ... WARNING: THIS UTILITY IS AN UNTESTED BETA, AND MAY CONTAIN MAJOR FLAWS. NOT FOR PRODUCTION USE! USE AT YOUR OWN RISK!

filterGenotypesByStat

UNTESTED ALPHA: FOR DEVELOPMENT/TESTING PURPOSES ONLY! DO NOT USE!

CreateVariantSampleTableV2

UNTESTED ALPHA: FOR DEVELOPMENT/TESTING PURPOSES ONLY! DO NOT USE!

RemoveUnwantedFields

UNTESTED ALPHA: FOR DEVELOPMENT/TESTING PURPOSES ONLY! DO NOT USE!

FilterVCF

UNTESTED ALPHA: FOR DEVELOPMENT/TESTING PURPOSES ONLY! DO NOT USE!

legacyCanonInfo

UNTESTED ALPHA: FOR DEVELOPMENT/TESTING PURPOSES ONLY! DO NOT USE!

CodingCoverageStats

UNTESTED ALPHA: FOR DEVELOPMENT/TESTING PURPOSES ONLY! DO NOT USE!

extractPotentialSvReads

UNTESTED ALPHA: FOR DEVELOPMENT/TESTING PURPOSES ONLY! DO NOT USE!

addGroupSummaries

UNTESTED ALPHA: FOR DEVELOPMENT/TESTING PURPOSES ONLY! DO NOT USE!

addTxBed

UNTESTED ALPHA: FOR DEVELOPMENT/TESTING PURPOSES ONLY! DO NOT USE!

CmdZip

UNTESTED ALPHA: FOR DEVELOPMENT/TESTING PURPOSES ONLY! DO NOT USE!

runVcfTest

Test utility.

legacyRedoDbnsfp

UNTESTED ALPHA: FOR DEVELOPMENT/TESTING PURPOSES ONLY! DO NOT USE!

legacyAddDomainInfo

UNTESTED ALPHA: FOR DEVELOPMENT/TESTING PURPOSES ONLY! DO NOT USE!

testTXSeqUtil

Test utility.

CmdAssessACMG

BETA: This function consolidates information from a wide variety of different input files and attempts to calculate a subset of the ACMG guidelines criteria. It then attempts to assign pathogenicity scores. WARNING: THIS UTILITY IS AN UNTESTED BETA, AND MAY CONTAIN MAJOR FLAWS. NOT FOR PRODUCTION USE! USE AT YOUR OWN RISK!

legacySplit

UNTESTED ALPHA: FOR DEVELOPMENT/TESTING PURPOSES ONLY! DO NOT USE!

GerpTrackToSpans

UNTESTED ALPHA: FOR DEVELOPMENT/TESTING PURPOSES ONLY! DO NOT USE!

ConvertToStandardVcf

UNTESTED ALPHA: FOR DEVELOPMENT/TESTING PURPOSES ONLY! DO NOT USE!

MergeManyVcf

UNTESTED ALPHA: FOR DEVELOPMENT/TESTING PURPOSES ONLY! DO NOT USE!

ConvertChromNames

UNTESTED ALPHA: FOR DEVELOPMENT/TESTING PURPOSES ONLY! DO NOT USE!

buildSummaryTracks

UNTESTED ALPHA: FOR DEVELOPMENT/TESTING PURPOSES ONLY! DO NOT USE!

oldWalkVcf

This utility performs a series of transformations on an input VCF file and adds an array of informative tags.

legacyTxAnno

This utility adds an array of new VCF tags with information about the transcriptional changes caused by each variant. WARNING: THIS UTILITY IS AN UNTESTED BETA, AND MAY CONTAIN MAJOR FLAWS. NOT FOR PRODUCTION USE! USE AT YOUR OWN RISK!

ConvertAminoRangeToGenoRange

UNTESTED ALPHA: FOR DEVELOPMENT/TESTING PURPOSES ONLY! DO NOT USE!

CalcVariantCountSummary

UNTESTED ALPHA: FOR DEVELOPMENT/TESTING PURPOSES ONLY! DO NOT USE!

CalcGenotypeStatTable

This takes a stat table for genotype statistics (such as GQ or AD). Warning: does not function on phased genotypes! UNTESTED ALPHA: FOR DEVELOPMENT/TESTING PURPOSES ONLY! DO NOT USE!

fixVcfInfoWhitespace

UNTESTED ALPHA: FOR DEVELOPMENT/TESTING PURPOSES ONLY! DO NOT USE!

SimSeqError

UNTESTED ALPHA: FOR DEVELOPMENT/TESTING PURPOSES ONLY! DO NOT USE!

compareVcfs

Compares two different VCFs containing different builds with overlapping sample sets.UNTESTED ALPHA: FOR DEVELOPMENT/TESTING PURPOSES ONLY! DO NOT USE!

VcfParserTest

This utility adds an array of new VCF tags with information about the transcriptional changes caused by each variant. WARNING: THIS UTILITY IS AN UNTESTED BETA, AND MAY CONTAIN MAJOR FLAWS. NOT FOR PRODUCTION USE! USE AT YOUR OWN RISK!

getHomopolymerBed

UNTESTED ALPHA: FOR DEVELOPMENT/TESTING PURPOSES ONLY! DO NOT USE!

HelloWorld

Test utility that just says hello world.

RecodeClinVarCLN

UNTESTED ALPHA: FOR DEVELOPMENT/TESTING PURPOSES ONLY! DO NOT USE!

CreateVariantSampleTable

UNTESTED ALPHA: FOR DEVELOPMENT/TESTING PURPOSES ONLY! DO NOT USE!

ibdSimulator

UNTESTED ALPHA: FOR DEVELOPMENT/TESTING PURPOSES ONLY! DO NOT USE!

extractSingletons

UNTESTED ALPHA: FOR DEVELOPMENT/TESTING PURPOSES ONLY! DO NOT USE!

AUTHORS:

Stephen W. Hartley, Ph.D. stephen.hartley (at nih dot gov)

LEGAL:

Written 2017-2019 by Stephen Hartley, PhD 
National Cancer Institute (NCI), Division of Cancer 
Epidemiology and Genetics (DCEG), Human Genetics Program
As a work of the United States Government, this software 
package and all related documentation and information is in the 
public domain within the United States. Additionally, the 
National Institutes of Health and the National Cancer Institute 
waives copyright and related rights in the work worldwide 
through the CC0 1.0 Universal Public Domain Dedication (which 
can be found at 
https://creativecommons.org/publicdomain/zero/1.0/).
Although all reasonable efforts have been taken to ensure the 
accuracy and reliability of the software and data, the National 
Human Genome Research Institute (NHGRI), the National Cancer 
Institute (NCI) and the U.S. Government does not and cannot 
warrant the performance or results that may be obtained by 
using this software or data. NHGRI, NCI and the U.S. Government 
disclaims all warranties as to performance, merchantability or 
fitness for any particular purpose.
In work or products derived from this material, proper 
attribution of the authors as the source of the software or 
data may be made using "NCI Division of Cancer Epidemiology and 
Genetics, Human Genetics Program" as the citation.
This package uses (but is not derived from) several 
externally-developed, open-source libraries which have been 
distributed under various open-source licenses. vArmyKnife is 
distributed with compiled versions of these packages.
Additional License information can be accessed using the 
command:
    vArmyKnife --help LICENSES
And can also found in the distributed source code in:
    src/main/resources/library.LICENSES.txt