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

[MRG] Improve documentation around abundance projection #1073

Merged
merged 4 commits into from Jul 13, 2020
Merged

Conversation

ctb
Copy link
Contributor

@ctb ctb commented Jul 3, 2020

Updates doc/classifying-signatures.md with abundance projection details.

Fixes #1041

  • Is it mergeable?
  • make test Did it pass the tests?
  • make coverage Is the new code covered?
  • Did it change the command-line interface? Only additions are allowed
    without a major version increment. Changing file formats also requires a
    major version number increment.
  • Was a spellchecker run on the source code and documentation after
    changes were made?

@codecov
Copy link

codecov bot commented Jul 3, 2020

Codecov Report

Merging #1073 into master will increase coverage by 8.96%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1073      +/-   ##
==========================================
+ Coverage   83.77%   92.73%   +8.96%     
==========================================
  Files          99       74      -25     
  Lines        8987     5631    -3356     
==========================================
- Hits         7529     5222    -2307     
+ Misses       1458      409    -1049     
Flag Coverage Δ
#rusttests ?
Impacted Files Coverage Δ
sourmash/signature.py 92.38% <0.00%> (-0.28%) ⬇️
sourmash/_minhash.py 94.69% <0.00%> (-0.27%) ⬇️
sourmash/command_compute.py 97.44% <0.00%> (-0.20%) ⬇️
sourmash/sbtmh.py 89.71% <0.00%> (-0.19%) ⬇️
sourmash/nodegraph.py 93.57% <0.00%> (-0.18%) ⬇️
sourmash/sbt_storage.py 92.00% <0.00%> (-0.12%) ⬇️
sourmash/index.py 97.61% <0.00%> (-0.09%) ⬇️
sourmash/sbt.py 88.79% <0.00%> (-0.07%) ⬇️
sourmash/lca/lca_db.py 96.20% <0.00%> (-0.06%) ⬇️
sourmash/cli/__init__.py 98.90% <0.00%> (-0.02%) ⬇️
... and 25 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d703b44...0ed1255. Read the comment docs.

@ctb
Copy link
Contributor Author

ctb commented Jul 3, 2020

Ready for review and merge @taylorreiter @bluegenes @erikyoung85, notwithstanding the test/build errors, which seem to be unrelated to the code changes.

Copy link
Contributor

@bluegenes bluegenes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo, otherwise LGTM.

It might be nice to provide the full code for generating the example data you use in the example (to enable folks to run it themselves), but it's also nice to keep things focused.

doc/classifying-signatures.md Outdated Show resolved Hide resolved
Co-authored-by: Tessa Pierce <bluegenes@users.noreply.github.com>
@ctb
Copy link
Contributor Author

ctb commented Jul 13, 2020

re providing code, it's in the test comments!

@ctb ctb merged commit f18f16c into master Jul 13, 2020
@ctb ctb deleted the update_abund_doc branch July 13, 2020 16:39
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

Successfully merging this pull request may close these issues.

fix comments in test_sourmash.py around abundance testing
2 participants