Skip to content

Commit

Permalink
Merge pull request #239 from tmaklin/fix-sketching-typos
Browse files Browse the repository at this point in the history
Fix option names for k-mer range min/max and k-mer step.
  • Loading branch information
johnlees committed Nov 4, 2022
2 parents 88c6010 + 1a3459b commit 75cb2aa
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/sketching.rst
Original file line number Diff line number Diff line change
Expand Up @@ -115,22 +115,22 @@ begin to fail.
At the other end, choosing a :math:`k` which is too long will result in all k-mers
mismatching. The greater the core distance :math:`\pi`, the lower the allowable maximum.

Some k-mer ranges for ``--k-min`` and ``--k-max`` we have found to work for various genomes:
Some k-mer ranges for ``--min-k`` and ``--max-k`` we have found to work for various genomes:

.. table:: k-mer lengths by domain
:widths: auto
:align: center

================== ================= =========== ===== =====
Domain/pathogen Typical :math:`l` :math:`\pi` k-min k-max
Domain/pathogen Typical :math:`l` :math:`\pi` min-k max-k
================== ================= =========== ===== =====
Beta-coronaviruses 20kb 0.1 6 15
Bacteria 2-5Mb ~0.01-0.04 13 29
Fungi 16Mb ~0.01 15 31
Plasmodium 23Mb 0.0005 17 31
================== ================= =========== ===== =====

A ``--kmer-step`` of four is usually sufficient, but drop this to two or three
A ``--k-step`` of four is usually sufficient, but drop this to two or three
to give the best accuracy at the expense of increased execution time.

A good model will have a straight line fit between :math:`\log(J)` and :math:`k`. Run
Expand Down

0 comments on commit 75cb2aa

Please sign in to comment.