Skip to content

Commit

Permalink
MRG: Various minor updates to docs (#2854)
Browse files Browse the repository at this point in the history
Adds FAQ to sidebar. Fixes
#2844.
Adds information about memory usage vs ksize to FAQ. Closes
#2843.
  • Loading branch information
ctb authored Dec 8, 2023
1 parent 52ef45c commit 326a747
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
11 changes: 11 additions & 0 deletions doc/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -245,3 +245,14 @@ read mapping between the metagenome and the relevant reference genome
or, if you are interested in retrieving accessory elements, you can
try out
[spacegraphcats](https://spacegraphcats.github.io/spacegraphcats/02-spacegraphcats-use-cases/).

## How does memory usage for sourmash change with k-mer size?

sourmash hashes k-mers into 64-bit numbers, so the size of what is
stored is independent of the k-mer size. The only impact of k-mer size
on sourmash behavior is then more on the biology side - how many
matches do you gain (or lose) with that k-mer size? And do you have a
lot of new k-mers that pop up with a longer k-mer size (e.g. because
of included variation)? These questions must be answered by experimentation
and may be data-set specific.

1 change: 1 addition & 0 deletions doc/sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ X and Linux. They require about 5 GB of disk space and 5 GB of RAM.
* [Publications about sourmash](publications.md)
* [A guide to the internal design and structure of sourmash](sourmash-internals.md)
* [Funding acknowledgements](funding.md)
* [Frequently asked questions](faq.md)

## Developing and extending sourmash

Expand Down

0 comments on commit 326a747

Please sign in to comment.