Skip to content

Commit c5a978f

Browse files
committed
Emphasize there is a difference when annotating from VCF/BCF vs tab-delimited annotation file (#2454)
1 parent 3be4629 commit c5a978f

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

doc/bcftools.txt

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -356,14 +356,17 @@ Add or remove annotations.
356356

357357
*-c, --columns* 'list'::
358358
Comma-separated list of columns or tags to carry over from the annotation file
359-
(see also *-a, --annotations*). If the annotation file is not a VCF/BCF,
359+
(see also *-a, --annotations*).
360+
{nbsp} +
361+
{nbsp} +
362+
*If the annotation file is not a VCF/BCF*,
360363
'list' describes the columns of the annotation file and must include CHROM,
361364
POS (or, alternatively, FROM,TO or BEG,END), and optionally REF and ALT. Unused
362365
columns which should be ignored can be indicated by "-".
363366
{nbsp} +
364367
{nbsp} +
365-
If the annotation file is a VCF/BCF, only the edited columns/tags must be present and their
366-
order does not matter. The columns ID, QUAL, FILTER, INFO and FORMAT
368+
*If the annotation file is a VCF/BCF*, only the edited columns/tags must be present
369+
(i.e. leave out CHROM, POS, REF, ALT) and their order does not matter. The columns ID, QUAL, FILTER, INFO and FORMAT
367370
can be edited, where INFO tags can be written both as "INFO/TAG" or simply "TAG",
368371
and FORMAT tags can be written as "FORMAT/TAG" or "FMT/TAG".
369372
The imported VCF annotations can be renamed as "DST_TAG:=SRC_TAG" or "FMT/DST_TAG:=FMT/SRC_TAG".

0 commit comments

Comments
 (0)