add more documentation about what gather does, and what the fields are.

sourmash-bio / sourmash

Quickly search, compare, and analyze genomic and metagenomic data sets.

http://sourmash.readthedocs.io/en/latest/

Other

453 stars 78 forks source link

add more documentation about what gather does, and what the fields are. #1227

Open ctb opened 3 years ago

ctb commented 3 years ago

as we explore the min-set-cov analysis, we're coming up with some interesting viz, e.g. #1225, and adding new output fields #1219. I think Appendix A, How sourmash gather works, could use some sprucing up as our new understanding evolves.

Specific ideas:

add some of our new figures! gathergram, in particular.
add some real examples, maybe
document output fields in a bit more detail

ctb commented 2 years ago

ref https://github.com/sourmash-bio/sourmash/issues/1789 and https://github.com/sourmash-bio/sourmash/issues/1799

ctb commented 1 year ago

there's a lot of updates here -

The new "lemonade" tutorial added in #2158 provides some discussion, as does the STAMPS 2022 lecture on assembly-free data analysis.

ref #2170 - use detection terminology.

still lots of room for improving the actual documentation 😆