-
Notifications
You must be signed in to change notification settings - Fork 79
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] Update documentation with links to new SBTs and a tutorial #216
Conversation
Codecov Report
@@ Coverage Diff @@
## master #216 +/- ##
=======================================
Coverage 85.78% 85.78%
=======================================
Files 13 13
Lines 1942 1942
Branches 52 52
=======================================
Hits 1666 1666
Misses 266 266
Partials 10 10 Continue to review full report at Codecov.
|
Ready for review! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some small comments about nomenclature, but overall 💯
doc/tutorials.md
Outdated
|
||
``` | ||
|
||
## Fingerprint reads |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should stick to one nomenclature: signature or fingerprint?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed in 7bdb1df
doc/tutorials.md
Outdated
wget https://s3.amazonaws.com/public.ged.msu.edu/ecoliMG1655.fa.gz | ||
``` | ||
|
||
Compute a scaled MinHash fingerprint from our reads: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same as above
Should be merged after #183 and #175.
Various documentation updates, including:
Note that the this depends on changes in #183 and #175, and so the
pip install
needs to be updated after those are merged; and the URLs for theeschericia-sigs.tar.gz
andshakya-unaligned-contigs.sig
files used in the tutorial should be updated to usemaster
before merge.make test
Did it pass the tests?make coverage
Is the new code covered?without a major version increment. Changing file formats also requires a
major version number increment.
changes were made?