Skip to content

Commit e19abd2

Browse files
authored
docs: Clarify highlight syntax and add VCF/BED file options
Updated usage documentation to clarify highlight option syntax and added details for VCF and BED file options.
1 parent e145133 commit e19abd2

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

src/docs/usage.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,15 @@ Arguments
5555
-
5656
* - highlight
5757
- -h
58-
- Interval or single base position that will be highlighted in the visualization. Example: 132400-132500 or 132440
58+
- Named intervals or single base positions that will be highlighted in the visualization. Example: myinterval:132400-132500 or myvariant:132440
59+
-
60+
* - vcf
61+
- -v
62+
- Path to a VCF file. Variants from the VCF file will be highlighted in the resulting plot similar to the highlight option.
63+
-
64+
* - bed
65+
-
66+
- Path to a BED file. Regions from the BED file will be highlighted in the resulting plot similar to the highlight option.
5967
-
6068
* - plot-all
6169
- -p

0 commit comments

Comments
 (0)