Skip to content

Commit 4735097

Browse files
committed
Update documentation
1 parent 3d994d3 commit 4735097

File tree

4 files changed

+8
-5
lines changed

4 files changed

+8
-5
lines changed

NEWS

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
## Release a.b
22

3+
Changes affecting the whole of bcftools, or multiple commands:
4+
5+
* Add support for matching lines by ID (#1739)
6+
37

48
Changes affecting specific commands:
59

doc/bcftools.txt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,6 @@ specific commands to see if they apply.
163163

164164
'id';;
165165
only records with identical ID column are compatible.
166-
Supported by *<<merge,bcftools merge>>* only.
167166

168167
*-f, --apply-filters* 'LIST'::
169168
Skip sites where FILTER column does not contain any of the strings listed
@@ -501,7 +500,7 @@ Add or remove annotations.
501500
*-O, --output-type* 'b'|'u'|'z'|'v'[0-9]::
502501
see *<<common_options,Common Options>>*
503502

504-
*--pair-logic* 'snps'|'indels'|'both'|'all'|'some'|'exact'::
503+
*--pair-logic* 'snps'|'indels'|'both'|'all'|'some'|'exact'|'id'::
505504
Controls how to match records from the annotation file to the target VCF.
506505
Effective only when *-a* is a VCF or BCF. The option replaces the former
507506
uninuitive *--collapse*.
@@ -1919,7 +1918,7 @@ on the options, the program can output records from one (or more) files
19191918
which have (or do not have) corresponding records with the same position
19201919
in the other files.
19211920

1922-
*-c, --collapse* 'snps'|'indels'|'both'|'all'|'some'|'none'::
1921+
*-c, --collapse* 'snps'|'indels'|'both'|'all'|'some'|'none'|'id'::
19231922
see *<<common_options,Common Options>>*
19241923

19251924
*-C, --complement*::

vcfannotate.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3658,7 +3658,7 @@ static void usage(args_t *args)
36583658
fprintf(stderr, " --no-version Do not append version and command line to the header\n");
36593659
fprintf(stderr, " -o, --output FILE Write output to a file [standard output]\n");
36603660
fprintf(stderr, " -O, --output-type u|b|v|z[0-9] u/b: un/compressed BCF, v/z: un/compressed VCF, 0-9: compression level [v]\n");
3661-
fprintf(stderr, " --pair-logic STR Matching records by <snps|indels|both|all|some|exact>, see man page for details [some]\n");
3661+
fprintf(stderr, " --pair-logic STR Matching records by <snps|indels|both|all|some|exact|id>, see man page for details [some]\n");
36623662
fprintf(stderr, " -r, --regions REGION Restrict to comma-separated list of regions\n");
36633663
fprintf(stderr, " -R, --regions-file FILE Restrict to regions listed in FILE\n");
36643664
fprintf(stderr, " --regions-overlap 0|1|2 Include if POS in the region (0), record overlaps (1), variant overlaps (2) [1]\n");

vcfisec.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -487,7 +487,7 @@ static void usage(void)
487487
fprintf(stderr, "Usage: bcftools isec [options] <A.vcf.gz> <B.vcf.gz> [...]\n");
488488
fprintf(stderr, "\n");
489489
fprintf(stderr, "Options:\n");
490-
fprintf(stderr, " -c, --collapse STRING Treat as identical records with <snps|indels|both|all|some|none>, see man page for details [none]\n");
490+
fprintf(stderr, " -c, --collapse STRING Treat as identical records with <snps|indels|both|all|some|none|id>, see man page for details [none]\n");
491491
fprintf(stderr, " -C, --complement Output positions present only in the first file but missing in the others\n");
492492
fprintf(stderr, " -e, --exclude EXPR Exclude sites for which the expression is true\n");
493493
fprintf(stderr, " -f, --apply-filters LIST Require at least one of the listed FILTER strings (e.g. \"PASS,.\")\n");

0 commit comments

Comments
 (0)