summaryrefslogtreecommitdiff
path: root/biology/bcftools/DESCR
diff options
context:
space:
mode:
Diffstat (limited to 'biology/bcftools/DESCR')
-rw-r--r--biology/bcftools/DESCR11
1 files changed, 11 insertions, 0 deletions
diff --git a/biology/bcftools/DESCR b/biology/bcftools/DESCR
new file mode 100644
index 00000000000..9cc66419380
--- /dev/null
+++ b/biology/bcftools/DESCR
@@ -0,0 +1,11 @@
+BCFtools is a program for variant calling and manipulating files in the Variant
+Call Format (VCF) and its binary counterpart BCF. All commands work
+transparently with both VCFs and BCFs, both uncompressed and BGZF-compressed.
+In order to avoid tedious repetion, throughout this document we will use "VCF"
+and "BCF" interchangeably, unless specifically noted.
+
+Most commands accept VCF, bgzipped VCF and BCF with filetype detected
+automatically even when streaming from a pipe. Indexed VCF and BCF work in all
+situations. Unindexed VCF and BCF and streams work in most, but not all
+situations. In general, whenever multiple VCFs are read simultaneously, they
+must be indexed and therefore also compressed.