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] Update documentation with links to new SBTs and a tutorial #216

Merged
merged 14 commits into from
May 16, 2017

Conversation

ctb
Copy link
Contributor

@ctb ctb commented May 14, 2017

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 the eschericia-sigs.tar.gz and shakya-unaligned-contigs.sig files used in the tutorial should be updated to use master before merge.

  • 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-io
Copy link

codecov-io commented May 14, 2017

Codecov Report

Merging #216 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           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.

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

@ctb ctb changed the title Update documentation with links to new SBTs and a tutorial [MRG] Update documentation with links to new SBTs and a tutorial May 14, 2017
@ctb
Copy link
Contributor Author

ctb commented May 14, 2017

Ready for review!

Copy link
Member

@luizirber luizirber left a 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
Copy link
Member

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?

Copy link
Contributor Author

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:
Copy link
Member

Choose a reason for hiding this comment

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

same as above

@luizirber luizirber merged commit c176cd2 into master May 16, 2017
@luizirber luizirber deleted the update/doc_sbts branch May 16, 2017 22:55
@luizirber luizirber mentioned this pull request May 16, 2017
5 tasks
@ctb ctb restored the update/doc_sbts branch May 16, 2017 23:28
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.

4 participants