added README.md

LindoNkambule · Oct 17, 2019 · c5f620b · c5f620b
1 parent 9a5f495
commit c5f620b
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,13 @@
+# VCFCompare
+A Python program for evaluating site-level concordance of a query VCF against a truth VCF.
+
+This tool compares two variant callsets against each other and produces a CSV file with summary metrics. The summary metric CSV file contains:
+* Variant type: SNV or INDEL
+* Total number of variants in the truth and query VCF files
+* Total true-positive, false-positive, and false-negative calls
+* Recall and Precision
+
+## Usage
+```
+python3 VCFCompare.py --truth truth.vcf --query query.vcf --output output
+```