Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Fix typo in modimizer sketch size
  • Loading branch information
alexsweeten authored Apr 23, 2024
1 parent c1d945a commit 4e4a492
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,8 +123,7 @@ Each partition takes into account a fraction of its neighboring partitions k-mer

`-m / --modimizer <int>`

Modimizer sketch size. Must be higher than window size `w`. A lower sketch size means less k-mers to compare (and faster runtime), at the expense of lower accuracy. Recommended to be kept > 1000.

Modimizer sketch size. Must be lower than window size `w`. A lower sketch size means less k-mers to compare (and faster runtime), at the expense of lower accuracy. Recommended to be kept > 1000.

`-r / --resolution <int>`

Expand All @@ -139,9 +138,11 @@ If set when 2 or more sequences are input into ModDotPlot, this will show an a v
If set when 2 or more sequences are input into ModDotPlot, this will show an a vs. b style plot, without showing self-identity plots.

`--ambiguous <bool>`

By default, k-mers that are homopolymers of ambiguous IUPAC codes (eg. NNNNNNNNNNN’s) are excluded from identity estimation. This results in gaps along the central diagonal for these regions. If desired, these can be kept by setting the `—-ambiguous` flag in both interactive and static mode.

`--no-plot <bool>`

Save matrix to file, but skip rendering of plots. In interactive mode, this must be used alongside the `--save` flag

---
Expand Down

0 comments on commit 4e4a492

Please sign in to comment.