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

suggestion: add k size note to sig merge help docs #2708

Closed
jessicalumian opened this issue Aug 9, 2023 · 2 comments · Fixed by #2713
Closed

suggestion: add k size note to sig merge help docs #2708

jessicalumian opened this issue Aug 9, 2023 · 2 comments · Fixed by #2713

Comments

@jessicalumian
Copy link

I was running the command

sourmash sig merge *.sig -o ref.sig

where each file in *.sig was calculated at k = 21,31,51. So I got the error:

== This is sourmash version 4.5.0. ==
== Please cite Brown and Irber (2016), doi:10.21105/joss.00027. ==

ERROR when merging signature '<file>' (45087801) from file <file>.sig
different ksizes cannot be compared

I figured out that I was missing a k flag (sourmash sig merge *.sig -o ref.sig -k 21) but the docs for sourmash sig merge don't specifically mention this: https://sourmash.readthedocs.io/en/latest/command-line.html#sourmash-signature-merge-merge-two-or-more-signatures-into-one

sourmash sig merge -h does mention this in the output, which is good!

Suggestion: add a note about this in the sourmash sig merge web docs, and potentially to all functions where k size should be specified.

Feel free to ignore this! Just thought I'd mention it. =]
@ctb ctb mentioned this issue Aug 12, 2023
Merged
6 tasks
@ctb
Copy link
Contributor

ctb commented Aug 12, 2023

Fixed in #2713!

@ctb
Copy link
Contributor

ctb commented Aug 12, 2023

@jessicalumian could you confirm that the new docs make sense? see #2713 header for direct links.

@ctb ctb closed this as completed in #2713 Aug 15, 2023
ctb added a commit that referenced this issue Aug 15, 2023
@ctb @luizirber
MRG: change matching_hashes.sig to matching-hashes.sig in documen…
c35cc19 
…tation (#2713)

Fixes #2709
Fixes #2708

For review -
- [ ] updated [prefetch
section](https://sourmash--2713.org.readthedocs.build/en/2713/command-line.html#caveats-and-comments)
- [ ] updated [sig intersect
docs](https://sourmash--2713.org.readthedocs.build/en/2713/command-line.html#sourmash-signature-intersect-intersect-two-or-more-signatures)
- [ ] updated [sig inflate
docs](https://sourmash--2713.org.readthedocs.build/en/2713/command-line.html#sourmash-signature-inflate-transfer-abundances-from-one-signature-to-others)
- [ ] updated [sig overlap
docs](https://sourmash--2713.org.readthedocs.build/en/2713/command-line.html#sourmash-signature-overlap-detailed-comparison-of-two-signatures-overlap)
- [ ] updated [sig merge
docs](https://sourmash--2713.org.readthedocs.build/en/2713/command-line.html#sourmash-signature-merge-merge-two-or-more-signatures-into-one)
- [ ] updated [sig subtract
docs](https://sourmash--2713.org.readthedocs.build/en/2713/command-line.html#sourmash-signature-subtract-subtract-other-signatures-from-a-signature)

---------

Co-authored-by: Luiz Irber <luizirber@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

MRG: change matching_hashes.sig to matching-hashes.sig in documentation sourmash-bio/sourmash
2 participants
@ctb @jessicalumian