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

provide better docs and/or examples for command line loading of signatures #1092

Closed
ctb opened this issue Jul 10, 2020 · 5 comments
Closed

Comments

@ctb
Copy link
Contributor

ctb commented Jul 10, 2020

per #1090, confusions abound now that #1059 has been merged. we say in the docs,

Note that as of sourmash v3.4, most commands will load signatures from indexed databases (the SBT and LCA formats) as well as from signature files.

but this isn't very prominent.

--

  • commands that take multiple input signatures can do so from databases!
  • --query-from-file should contain a list of files you want to load from
  • --query typically supports multiple files
  • query signatures support loading from databases, etc., but you gotta pick just one (for e.g. search and gather). multigather will let you load many!

other things to mention:

  • big LCA databases may take a while to load, while SBTs may be slower
@ctb
Copy link
Contributor Author

ctb commented Jul 10, 2020

big question is, what do we write and/or focus on?

  • example queries, either in the specific command sections or in their own section
  • better documentation in the specific commands
  • high level documentation under "advanced command line usage" or something

not sure where our energies are best spent.

@ctb
Copy link
Contributor Author

ctb commented Jul 10, 2020

(right now I'm leaning towards an 'advanced usage' section that also lays out our design considerations.)

@ctb ctb mentioned this issue Jul 11, 2020
5 tasks
@ctb
Copy link
Contributor Author

ctb commented Jul 11, 2020

@ctb
Copy link
Contributor Author

ctb commented Feb 8, 2021

Looking at command-line.md, "advanced-command-line-usage", I'm actually pretty happy with what we have there. No plans to change prior to 4.0.

@ctb
Copy link
Contributor Author

ctb commented May 4, 2022

this is largely fixed in the docs by #2025 and others, I think. We could probably use more examples but that's always gonna be true

@ctb ctb closed this as completed May 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant