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.

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

search --containment needs better documentation and takes arguments in reverse of prefetch and gather #2968

Closed
ctb opened this issue Feb 4, 2024 · 2 comments · Fixed by #2971
Labels
doc documentation content or issues

Comments

@ctb
Copy link
Contributor

ctb commented Feb 4, 2024

ok so I'm working on helping someone with debugging a thing, and I just noticed: sourmash search --containment A B shows the containment of A in B. That is, if you have a metagenome and a genome, you want to do:

search --containment genome metagenome

this is the opposite of prefetch and gather, both of which take the metagenome as the left-hand-side or query.

The docs for search are not clear on this 😅 .

ref:

@ctb
Copy link
Contributor Author

ctb commented Feb 4, 2024

I guess this makes some sense - you are used to searching for something in a list of databases, so search query targets makes sense here. I'm just completely brainwashed by thinking about gather so much!

@ctb ctb added the doc documentation content or issues label Feb 4, 2024
@ctb
Copy link
Contributor Author

ctb commented Feb 4, 2024

note to self: remember to update the argparse help as well.

@ctb ctb closed this as completed in #2971 Feb 5, 2024
ctb added a commit that referenced this issue Feb 5, 2024
…fetch` (#2971)

Adds useful information about the order of containment searches:
* `search --containment A B` reports A contained in B;
* `prefetch A B` reports B contained in A;

Fixes #2968.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc documentation content or issues
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant