Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

MRG: Various minor updates to docs #2854

Merged
merged 5 commits into from
Dec 8, 2023
Merged

MRG: Various minor updates to docs #2854

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
925b3e4
add FAQ to sidebar
ctb Nov 28, 2023
4cb056f
add memory usage vs ksize to FAQ
ctb Nov 28, 2023
9a5eee4
Merge branch 'latest' into more_docs
luizirber Dec 5, 2023
216aad0
Merge branch 'latest' into more_docs
ctb Dec 7, 2023
104cfc8
Merge branch 'latest' into more_docs
ctb Dec 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions doc/faq.md
View file
Open in desktop
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
View file
Open in desktop
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
Loading