Skip to content

[MRG] Clean up "introduction" text in docs - #1684

Merged
standage merged 7 commits into
masterfrom
doc/fix-intro
May 20, 2017
Merged

standage merged 7 commits into
masterfrom
doc/fix-intro

Conversation

@standage

@standage standage commented Apr 27, 2017 •

Copy link
Copy Markdown
Member

Doing my best to bring this up-to-date. See #853.

  • Is it mergeable?
  • make test Did it pass the tests?
  • Was a spellchecker run on the source code and documentation after
    changes were made?

Comment thread doc/introduction.rst

- counting k-mers and estimating data set coverage based on k-mer counts;

- running Velvet and calculating assembly statistics;

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Really? Is this still true?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

indeed it is not true :)

Comment thread doc/introduction.rst
The most important thing to think about when using khmer is whether or not the transformation or filter you're applying is appropriate for the data you're trying to assemble.
For example, two of the most powerful operations available in khmer, graph-size filtering and graph partitioning, only make sense for assembly datasets with many theoretically unconnected components.
This is typical of metagenomic data sets.
Also, while digital normalization can be helpful for transcriptome *assembly*, it is inappropriate for other RNA-seq applications, such as differential expression analysis, that rely on signal from variable coverage.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Too soon?

Comment thread doc/introduction.rst

- optimizing assemblies on various parameters;

- converting FASTQ to FASTA;

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Could also mention interleaving/decoupling fastq.

@codecov-io

codecov-io commented Apr 27, 2017 •

Copy link
Copy Markdown

Codecov Report

Merging #1684 into master will decrease coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1684      +/-   ##
==========================================
- Coverage   64.16%   64.16%   -0.01%     
==========================================
  Files          79       79              
  Lines       12189    12188       -1     
  Branches     3072     3072              
==========================================
- Hits         7821     7820       -1     
- Misses       2670     2671       +1     
+ Partials     1698     1697       -1
Impacted Files Coverage Δ
lib/hashtable.cc 56.91% <0%> (-0.23%) ⬇️

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 d40a81a...674b763. Read the comment docs.

@standage

Copy link
Copy Markdown
Member Author

This is ready for review. I'm guessing @ctb will want a crack at this.

@standage standage changed the title Clean up "introduction" text in docs [MRG] Clean up "introduction" text in docs Apr 27, 2017
@standage

standage commented May 9, 2017

Copy link
Copy Markdown
Member Author

*bump*

@standage

standage commented May 17, 2017 •

Copy link
Copy Markdown
Member Author

@betatim and @luizirber and I are going to hack a bit on khmer at PyCon (and @camillescott, if she's coming and interested). If @ctb has not reviewed this by then I'll recruit someone else to review this then. Hopefully we can check all of the remaining 2.1 release boxes before PyCon is over.

@ctb

ctb commented May 18, 2017

Copy link
Copy Markdown
Member

What's my deadline on this? I can get to it Sat morning for sure, Friday if it's urgent.

Then at PyCon y'all could release khmer 2.1, and maybe get the new Cython stuff (#1595) merged as well as #1590.

@standage

Copy link
Copy Markdown
Member Author

No specific sense of urgency, just didn't want the PR (and thus the release) to languish for an indeterminate amount of time. It can definitely wait until Saturday. :-)

@ctb ctb left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM other than comment!

@standage
standage merged commit 61c1fdb into master May 20, 2017
@standage
standage deleted the doc/fix-intro branch May 20, 2017 18:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants