Skip to content

Commit

Permalink
More prep for 1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
DerrickWood committed Oct 20, 2017
1 parent 7a9ace0 commit 11941c8
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/MANUAL.html
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,7 @@ <h1 id="kraken-environment-variables">Kraken Environment Variables</h1>
<p>will use <code>/data/kraken_dbs/mainDB</code> to classify <code>sequences.fa</code>.</p></li>
</ul>
<h1 id="upgrading-databases-to-v0.10">Upgrading Databases to v0.10+</h1>
<p>The minimizer ordering in Kraken versions prior to v0.10.0-beta was a simple lexicographical ordering that provided a suboptimal distribution of k-mers within the bins. Ideally, the bin sizes would be uniform, but simple lexicographical ordering creates a bias toward low-complexity minimizers. To resolve this, the ordering is now &quot;scrambled&quot; by XORing all minimizers with a predefined constant to toggle half of each minimizer's bits before sorting. The more evenly distributed bins provide better caching performance, but databases created in this way are not compatible with earlier versions of Kraken. Kraken versions from v0.10.0-beta up to (but not including) v1.0 will support the use of the older databases, but we nonetheless recommend one of the two following options:</p>
<p>The minimizer ordering in Kraken versions prior to v0.10.0-beta was a simple lexicographical ordering that provided a suboptimal distribution of k-mers within the bins. Ideally, the bin sizes would be uniform, but simple lexicographical ordering creates a bias toward low-complexity minimizers. To resolve this, the ordering is now &quot;scrambled&quot; by XORing all minimizers with a predefined constant to toggle half of each minimizer's bits before sorting. The more evenly distributed bins provide better caching performance, but databases created in this way are not compatible with earlier versions of Kraken. Kraken versions from v0.10.0-beta up to (and including) v1.0 will support the use of the older databases, but we nonetheless recommend one of the two following options:</p>
<ol style="list-style-type: decimal">
<li><p>Build a new database. This is the preferred option, as a newly-created database will have the latest genomes and NCBI taxonomy information.</p></li>
<li><p>Re-sort an existing database. If you have a custom database, you may want to simply reformat the database to provide you with Kraken's increased speed. To do so, you'll need to do the following:</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/MANUAL.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -730,7 +730,7 @@ minimizers with a predefined constant to toggle half of each minimizer's
bits before sorting. The more evenly distributed bins provide better
caching performance, but databases created in this way are not compatible
with earlier versions of Kraken. Kraken versions from v0.10.0-beta up to
(but not including) v1.0 will support the use of the older databases, but
(and including) v1.0 will support the use of the older databases, but
we nonetheless recommend one of the two following options:

1) Build a new database. This is the preferred option, as a newly-created
Expand Down

0 comments on commit 11941c8

Please sign in to comment.