| 1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> |
| 2 |
<!-- Manual page created with latex2man on Wed Feb 29 10:58:49 EST 2012 -- |
| 3 |
-- Author of latex2man: [email protected] -- |
| 4 |
-- NOTE: This file is generated, DO NOT EDIT. --> |
| 5 |
<html> |
| 6 |
<head><title>JELLYFISH</title></head> |
| 7 |
<body bgcolor="white"> |
| 8 |
<h1 align=center> |
| 9 |
Jellyfish: A fast k-mer counter |
| 10 |
</h1> |
| 11 |
<h4 align=center>G. Marcais and C. Kingsford </h4> |
| 12 |
<h4 align=center>2010/10/1</h4> |
| 13 |
<h4 align=center>Version 1.1.4</h4> |
| 14 |
<p> |
| 15 |
<tt>Jellyfish</tt> |
| 16 |
is a software to count k-mers in DNA sequences. |
| 17 |
<p> |
| 18 |
<h3>Table of Contents</h3> |
| 19 |
<ul> |
| 20 |
<li><a href="#section_1">Synopsis </a></li> |
| 21 |
<li><a href="#section_2">Description </a> |
| 22 |
<ul> |
| 23 |
<li><a href="#section_3">Counting and merging </a></li> |
| 24 |
<li><a href="#section_4">Orientation </a></li> |
| 25 |
<li><a href="#section_5">Choosing the hash size </a></li> |
| 26 |
<li><a href="#section_6">Choosing the counting field size </a></li> |
| 27 |
</ul> |
| 28 |
<li><a href="#section_7">Subcommands and options </a> |
| 29 |
<ul> |
| 30 |
<li><a href="#section_8">count </a></li> |
| 31 |
<li><a href="#section_9">stats </a></li> |
| 32 |
<li><a href="#section_10">histo </a></li> |
| 33 |
<li><a href="#section_11">dump </a></li> |
| 34 |
<li><a href="#section_12">merge </a></li> |
| 35 |
<li><a href="#section_13">query </a></li> |
| 36 |
<li><a href="#section_14">qhisto </a></li> |
| 37 |
<li><a href="#section_15">qdump </a></li> |
| 38 |
<li><a href="#section_16">qmerge </a></li> |
| 39 |
<li><a href="#section_17">cite </a></li> |
| 40 |
</ul> |
| 41 |
<li><a href="#section_18">Version </a></li> |
| 42 |
<li><a href="#section_19">Bugs </a></li> |
| 43 |
<li><a href="#section_20">Copyright & License </a></li> |
| 44 |
<li><a href="#section_21">Authors </a></li> |
| 45 |
</ul> |
| 46 |
<p> |
| 47 |
<h2><a name="section_1">Synopsis</a></h2> |
| 48 |
|
| 49 |
<tt>jellyfish count</tt> |
| 50 |
[<b>-o</b><i>prefix</i>] |
| 51 |
[<b>-m</b><i>merlength</i>] |
| 52 |
[<b>-t</b><i>threads</i>] |
| 53 |
[<b>-s</b><i>hashsize</i>] |
| 54 |
[<b>--both-strands</b>] |
| 55 |
<i>fasta</i> |
| 56 |
[<i>fasta ...</i>] |
| 57 |
<br> |
| 58 |
<tt>jellyfish merge</tt> |
| 59 |
<i>hash1</i> |
| 60 |
<i>hash2</i> |
| 61 |
...<br> |
| 62 |
<tt>jellyfish dump</tt> |
| 63 |
<i>hash</i> |
| 64 |
<br> |
| 65 |
<tt>jellyfish stats</tt> |
| 66 |
<i>hash</i> |
| 67 |
<br> |
| 68 |
<tt>jellyfish histo</tt> |
| 69 |
[<b>-h</b><i>high</i>] |
| 70 |
[<b>-l</b><i>low</i>] |
| 71 |
[<b>-i</b><i>increment</i>] |
| 72 |
<i>hash</i> |
| 73 |
<br> |
| 74 |
<tt>jellyfish query</tt> |
| 75 |
<i>hash</i> |
| 76 |
<br> |
| 77 |
<tt>jellyfish cite</tt> |
| 78 |
<br> |
| 79 |
<p> |
| 80 |
Plus equivalent version for <tt>Quake</tt> |
| 81 |
mode: <tt>qhisto</tt>, |
| 82 |
<tt>qdump</tt> |
| 83 |
and <tt>qmerge</tt>. |
| 84 |
<p> |
| 85 |
<h2><a name="section_2">Description</a></h2> |
| 86 |
|
| 87 |
<p> |
| 88 |
<tt>Jellyfish</tt> |
| 89 |
is a k-mer counter based on a multi-threaded hash |
| 90 |
table implementation. |
| 91 |
<p> |
| 92 |
<h4><a name="section_3">Counting and merging</a></h4> |
| 93 |
|
| 94 |
<p> |
| 95 |
To count k-mers, use a command like: |
| 96 |
<p> |
| 97 |
<pre> |
| 98 |
jellyfish count -m 22 -o output -c 3 -s 10000000 -t 32 input.fasta |
| 99 |
</pre> |
| 100 |
<p> |
| 101 |
This will count the the 22-mers in input.fasta with 32 threads. The |
| 102 |
counter field in the hash uses only 3 bits and the hash has at least |
| 103 |
10 million entries. |
| 104 |
<p> |
| 105 |
The output files will be named output_0, output_1, etc. (the prefix |
| 106 |
is specified with the <b>-o</b> |
| 107 |
switch). If the hash is large enough |
| 108 |
(has specified by the <b>-s</b> |
| 109 |
switch) to fit all the k-mers, there |
| 110 |
will be only one output file named output_0. If the hash filled up |
| 111 |
before all the mers were read, the hash is dumped to disk, zeroed out |
| 112 |
and reading in mers resumes. Multiple intermediary files will be |
| 113 |
present on the disks, named output_0, output_1, etc. |
| 114 |
<p> |
| 115 |
To obtain correct results from the other sub-commands (such as histo, |
| 116 |
stats, etc.), the multiple output files, if any, need to be merged into one |
| 117 |
with the merge command. For example with the following command: |
| 118 |
<p> |
| 119 |
<pre> |
| 120 |
jellyfish merge -o output.jf output\_* |
| 121 |
</pre> |
| 122 |
<p> |
| 123 |
Should you get many intermediary output files (say hundreds), the size |
| 124 |
of the hash table is too small. Rerunning <tt>Jellyfish</tt> |
| 125 |
with a |
| 126 |
larger size (option <b>-s</b>) |
| 127 |
is probably faster than merging all the |
| 128 |
intermediary files. |
| 129 |
<p> |
| 130 |
<h4><a name="section_4">Orientation</a></h4> |
| 131 |
|
| 132 |
When the orientation of the sequences in the input fasta file is not |
| 133 |
known, e.g. in sequencing reads, using <b>--both-strands</b> |
| 134 |
(<b>-C</b>) |
| 135 |
makes the most sense. |
| 136 |
<p> |
| 137 |
For any k-mer m, its canonical representation is m itself or its |
| 138 |
reverse-complement, whichever comes first lexicographically. With the |
| 139 |
option <b>-C</b>, |
| 140 |
only the canonical representation of the mers are |
| 141 |
stored in the hash and the count value is the number of occurrences of |
| 142 |
both the mer and its reverse-complement. |
| 143 |
<p> |
| 144 |
<h4><a name="section_5">Choosing the hash size</a></h4> |
| 145 |
|
| 146 |
<p> |
| 147 |
To achieve the best performance, a minimum number of intermediary |
| 148 |
files should be written to disk. So the parameter <b>-s</b> |
| 149 |
should be |
| 150 |
chosen to fit as many k-mers as possible (ideally all of them) while |
| 151 |
still fitting in memory. |
| 152 |
<p> |
| 153 |
We consider to examples: counting mers in sequencing reads and in a |
| 154 |
finished genome. |
| 155 |
<p> |
| 156 |
First, suppose we count k-mers in short sequencing reads: |
| 157 |
there are n reads and there is an average of 1 error per reads where |
| 158 |
each error generates k unique mers. If the genome size is G, the |
| 159 |
size of the hash (option <b>-s</b>) |
| 160 |
to fit all k-mers at once is estimated to: $(G + |
| 161 |
k*n)/0.8$. The division by 0.8 compensates for the maximum usage of |
| 162 |
approximately $80%$ of the hash table. |
| 163 |
<p> |
| 164 |
On the other hand, when counting k-mers in an assembled sequence of |
| 165 |
length G, setting <b>-s</b> |
| 166 |
to G is appropriate. |
| 167 |
<p> |
| 168 |
As a matter of convenience, Jellyfish understands ISO suffixes for the |
| 169 |
size of the hash. Hence '-s 10M' stands 10 million entries while '-s |
| 170 |
50G' stands for 50 billion entries. |
| 171 |
<p> |
| 172 |
The actual memory usage of the hash table can be computed as |
| 173 |
follow. The actual size of the hash will be rounded up to the next |
| 174 |
power of 2: s=2^l. The parameter r is such that the maximum |
| 175 |
reprobe value (<b>-p</b>) |
| 176 |
plus one is less than 2^r. Then the memory usage per |
| 177 |
entry in the hash is (in bits, not bytes) 2k-l+r+1. The total memory |
| 178 |
usage of the hash table in bytes is: 2^l*(2k-l+r+1)/8. |
| 179 |
<p> |
| 180 |
<h4><a name="section_6">Choosing the counting field size</a></h4> |
| 181 |
|
| 182 |
To save space, the hash table supports variable length counter, i.e. a |
| 183 |
k-mer occurring only a few times will use a small counter, a k-mer |
| 184 |
occurring many times will used multiple entries in the hash. |
| 185 |
<p> |
| 186 |
Important: the size of the couting field does NOT change the result, |
| 187 |
it only impacts the amount of memory used. In particular, there is no |
| 188 |
maximum value in the hash. Even if the counting field uses 5 bits, a |
| 189 |
k-mer occuring 2 million times will have a value reported of 2 |
| 190 |
million (i.e., it is not capped at 2^5). |
| 191 |
<p> |
| 192 |
The <b>-c</b> |
| 193 |
specify the length (in bits) of the counting field. The |
| 194 |
trade off is as follows: a low value will save space per entry in the |
| 195 |
hash but can potentially increase the number of entries used, hence |
| 196 |
maybe requiring a larger hash. |
| 197 |
<p> |
| 198 |
In practice, use a value for <b>-c</b> |
| 199 |
so that most of you k-mers |
| 200 |
require only 1 entry. For example, to count k-mers in a genome, |
| 201 |
where most of the sequence is unique, use <b>-c</b><i>1</i> |
| 202 |
or |
| 203 |
<b>-c</b><i>2</i>. |
| 204 |
For sequencing reads, use a value for <b>-c</b> |
| 205 |
large |
| 206 |
enough to counts up to twice the coverage. For example, if the |
| 207 |
coverage is 10X, choose a counter length of 5 (<b>-c</b><i>5</i>) |
| 208 |
as $2^5 > 20$. |
| 209 |
<p> |
| 210 |
<h2><a name="section_7">Subcommands and options</a></h2> |
| 211 |
|
| 212 |
<h4><a name="section_8">count</a></h4> |
| 213 |
|
| 214 |
Usage: jellyfish count [options] file:path+ |
| 215 |
<p> |
| 216 |
Count k-mers or qmers in fasta or fastq files |
| 217 |
<p> |
| 218 |
Options (default value in (), *required): |
| 219 |
<dl compact> |
| 220 |
<dt><b>-m</b>, |
| 221 |
<b>--mer-len</b><i>=uint32</i> |
| 222 |
</dt> |
| 223 |
<dd> *Length of mer |
| 224 |
</dd> |
| 225 |
<dt><b>-s</b>, |
| 226 |
<b>--size</b><i>=uint64</i> |
| 227 |
</dt> |
| 228 |
<dd> *Hash size |
| 229 |
</dd> |
| 230 |
<dt><b>-t</b>, |
| 231 |
<b>--threads</b><i>=uint32</i> |
| 232 |
</dt> |
| 233 |
<dd> Number of threads (1) |
| 234 |
</dd> |
| 235 |
<dt><b>-o</b>, |
| 236 |
<b>--output</b><i>=string</i> |
| 237 |
</dt> |
| 238 |
<dd> Output prefix (mer_counts) |
| 239 |
</dd> |
| 240 |
<dt><b>-c</b>, |
| 241 |
<b>--counter-len</b><i>=Length</i> |
| 242 |
</dt> |
| 243 |
<dd> in bits Length of counting field (7) |
| 244 |
</dd> |
| 245 |
<dt><b>--out-counter-len</b><i>=Length</i> |
| 246 |
</dt> |
| 247 |
<dd> in bytes Length of counter field in output (4) |
| 248 |
</dd> |
| 249 |
<dt><b>-C</b>,<b>--both-strands</b> |
| 250 |
</dt> |
| 251 |
<dd> Count both strand, canonical representation (false) |
| 252 |
</dd> |
| 253 |
<dt><b>-p</b>, |
| 254 |
<b>--reprobes</b><i>=uint32</i> |
| 255 |
</dt> |
| 256 |
<dd> Maximum number of reprobes (62) |
| 257 |
</dd> |
| 258 |
<dt><b>-r</b>,<b>--raw</b> |
| 259 |
</dt> |
| 260 |
<dd> Write raw database (false) |
| 261 |
</dd> |
| 262 |
<dt><b>-q</b>,<b>--quake</b> |
| 263 |
</dt> |
| 264 |
<dd> Quake compatibility mode (false) |
| 265 |
</dd> |
| 266 |
<dt><b>--quality-start</b><i>=uint32</i> |
| 267 |
</dt> |
| 268 |
<dd> Starting ASCII for quality values (64) |
| 269 |
</dd> |
| 270 |
<dt><b>--min-quality</b><i>=uint32</i> |
| 271 |
</dt> |
| 272 |
<dd> Minimum quality. A base with lesser quality becomes an N (0) |
| 273 |
</dd> |
| 274 |
<dt><b>-L</b>, |
| 275 |
<b>--lower-count</b><i>=uint64</i> |
| 276 |
</dt> |
| 277 |
<dd> Don't output k-mer with count < lower-count |
| 278 |
</dd> |
| 279 |
<dt><b>-U</b>, |
| 280 |
<b>--upper-count</b><i>=uint64</i> |
| 281 |
</dt> |
| 282 |
<dd> Don't output k-mer with count > upper-count |
| 283 |
</dd> |
| 284 |
<dt><b>--matrix</b><i>=Matrix</i> |
| 285 |
</dt> |
| 286 |
<dd> file Hash function binary matrix |
| 287 |
</dd> |
| 288 |
<dt><b>--timing</b><i>=Timing</i> |
| 289 |
</dt> |
| 290 |
<dd> file Print timing information |
| 291 |
</dd> |
| 292 |
<dt><b>--stats</b><i>=Stats</i> |
| 293 |
</dt> |
| 294 |
<dd> file Print stats |
| 295 |
</dd> |
| 296 |
<dt><b>--usage</b> |
| 297 |
</dt> |
| 298 |
<dd> Usage |
| 299 |
</dd> |
| 300 |
<dt><b>-h</b>,<b>--help</b> |
| 301 |
</dt> |
| 302 |
<dd> This message |
| 303 |
</dd> |
| 304 |
<dt><b>--full-help</b> |
| 305 |
</dt> |
| 306 |
<dd> Detailed help |
| 307 |
</dd> |
| 308 |
<dt><b>-V</b>,<b>--version</b> |
| 309 |
</dt> |
| 310 |
<dd> Version |
| 311 |
</dd> |
| 312 |
</dl> |
| 313 |
<p> |
| 314 |
<h4><a name="section_9">stats</a></h4> |
| 315 |
|
| 316 |
Usage: jellyfish stats [options] db:path |
| 317 |
<p> |
| 318 |
Statistics |
| 319 |
<p> |
| 320 |
Display some statistics about the k-mers in the hash: |
| 321 |
<p> |
| 322 |
Unique: Number of k-mers which occur only once. |
| 323 |
Distinct: Number of k-mers, not counting multiplicity. |
| 324 |
Total: Number of k-mers, including multiplicity. |
| 325 |
Max_count: Maximum number of occurrence of a k-mer. |
| 326 |
<p> |
| 327 |
Options (default value in (), *required): |
| 328 |
<dl compact> |
| 329 |
<dt><b>-L</b>, |
| 330 |
<b>--lower-count</b><i>=uint64</i> |
| 331 |
</dt> |
| 332 |
<dd> Don't consider k-mer with count < lower-count |
| 333 |
</dd> |
| 334 |
<dt><b>-U</b>, |
| 335 |
<b>--upper-count</b><i>=uint64</i> |
| 336 |
</dt> |
| 337 |
<dd> Don't consider k-mer with count > upper-count |
| 338 |
</dd> |
| 339 |
<dt><b>-v</b>,<b>--verbose</b> |
| 340 |
</dt> |
| 341 |
<dd> Verbose (false) |
| 342 |
</dd> |
| 343 |
<dt><b>-o</b>, |
| 344 |
<b>--output</b><i>=string</i> |
| 345 |
</dt> |
| 346 |
<dd> Output file |
| 347 |
</dd> |
| 348 |
<dt><b>--usage</b> |
| 349 |
</dt> |
| 350 |
<dd> Usage |
| 351 |
</dd> |
| 352 |
<dt><b>-h</b>,<b>--help</b> |
| 353 |
</dt> |
| 354 |
<dd> This message |
| 355 |
</dd> |
| 356 |
<dt><b>--full-help</b> |
| 357 |
</dt> |
| 358 |
<dd> Detailed help |
| 359 |
</dd> |
| 360 |
<dt><b>-V</b>,<b>--version</b> |
| 361 |
</dt> |
| 362 |
<dd> Version |
| 363 |
</dd> |
| 364 |
</dl> |
| 365 |
<p> |
| 366 |
<h4><a name="section_10">histo</a></h4> |
| 367 |
|
| 368 |
Usage: jellyfish histo [options] db:path |
| 369 |
<p> |
| 370 |
Create an histogram of k-mer occurrences |
| 371 |
<p> |
| 372 |
Create an histogram with the number of k-mers having a given |
| 373 |
count. In bucket 'i' are tallied the k-mers which have a count 'c' |
| 374 |
satisfying 'low+i*inc <= c < low+(i+1)*inc'. Buckets in the output are |
| 375 |
labeled by the low end point (low+i*inc). |
| 376 |
<p> |
| 377 |
The last bucket in the output behaves as a catchall: it tallies all |
| 378 |
k-mers with a count greater or equal to the low end point of this |
| 379 |
bucket. |
| 380 |
<p> |
| 381 |
Options (default value in (), *required): |
| 382 |
<dl compact> |
| 383 |
<dt><b>-l</b>, |
| 384 |
<b>--low</b><i>=uint64</i> |
| 385 |
</dt> |
| 386 |
<dd> Low count value of histogram (1) |
| 387 |
</dd> |
| 388 |
<dt><b>-h</b>, |
| 389 |
<b>--high</b><i>=uint64</i> |
| 390 |
</dt> |
| 391 |
<dd> High count value of histogram (10000) |
| 392 |
</dd> |
| 393 |
<dt><b>-i</b>, |
| 394 |
<b>--increment</b><i>=uint64</i> |
| 395 |
</dt> |
| 396 |
<dd> Increment value for buckets (1) |
| 397 |
</dd> |
| 398 |
<dt><b>-t</b>, |
| 399 |
<b>--threads</b><i>=uint32</i> |
| 400 |
</dt> |
| 401 |
<dd> Number of threads (1) |
| 402 |
</dd> |
| 403 |
<dt><b>-f</b>,<b>--full</b> |
| 404 |
</dt> |
| 405 |
<dd> Full histo. Don't skip count 0. (false) |
| 406 |
</dd> |
| 407 |
<dt><b>-o</b>, |
| 408 |
<b>--output</b><i>=string</i> |
| 409 |
</dt> |
| 410 |
<dd> Output file |
| 411 |
</dd> |
| 412 |
<dt><b>-v</b>,<b>--verbose</b> |
| 413 |
</dt> |
| 414 |
<dd> Output information (false) |
| 415 |
</dd> |
| 416 |
<dt><b>--usage</b> |
| 417 |
</dt> |
| 418 |
<dd> Usage |
| 419 |
</dd> |
| 420 |
<dt><b>--help</b> |
| 421 |
</dt> |
| 422 |
<dd> This message |
| 423 |
</dd> |
| 424 |
<dt><b>--full-help</b> |
| 425 |
</dt> |
| 426 |
<dd> Detailed help |
| 427 |
</dd> |
| 428 |
<dt><b>-V</b>,<b>--version</b> |
| 429 |
</dt> |
| 430 |
<dd> Version |
| 431 |
</dd> |
| 432 |
</dl> |
| 433 |
<p> |
| 434 |
<h4><a name="section_11">dump</a></h4> |
| 435 |
|
| 436 |
Usage: jellyfish dump [options] db:path |
| 437 |
<p> |
| 438 |
Dump k-mer counts |
| 439 |
<p> |
| 440 |
By default, dump in a fasta format where the header is the count and |
| 441 |
the sequence is the sequence of the k-mer. The column format is a 2 |
| 442 |
column output: k-mer count. |
| 443 |
<p> |
| 444 |
Options (default value in (), *required): |
| 445 |
<dl compact> |
| 446 |
<dt><b>-c</b>,<b>--column</b> |
| 447 |
</dt> |
| 448 |
<dd> Column format (false) |
| 449 |
</dd> |
| 450 |
<dt><b>-t</b>,<b>--tab</b> |
| 451 |
</dt> |
| 452 |
<dd> Tab separator (false) |
| 453 |
</dd> |
| 454 |
<dt><b>-L</b>, |
| 455 |
<b>--lower-count</b><i>=uint64</i> |
| 456 |
</dt> |
| 457 |
<dd> Don't output k-mer with count < lower-count |
| 458 |
</dd> |
| 459 |
<dt><b>-U</b>, |
| 460 |
<b>--upper-count</b><i>=uint64</i> |
| 461 |
</dt> |
| 462 |
<dd> Don't output k-mer with count > upper-count |
| 463 |
</dd> |
| 464 |
<dt><b>-o</b>, |
| 465 |
<b>--output</b><i>=string</i> |
| 466 |
</dt> |
| 467 |
<dd> Output file |
| 468 |
</dd> |
| 469 |
<dt><b>--usage</b> |
| 470 |
</dt> |
| 471 |
<dd> Usage |
| 472 |
</dd> |
| 473 |
<dt><b>-h</b>,<b>--help</b> |
| 474 |
</dt> |
| 475 |
<dd> This message |
| 476 |
</dd> |
| 477 |
<dt><b>-V</b>,<b>--version</b> |
| 478 |
</dt> |
| 479 |
<dd> Version |
| 480 |
</dd> |
| 481 |
</dl> |
| 482 |
<p> |
| 483 |
<h4><a name="section_12">merge</a></h4> |
| 484 |
|
| 485 |
Usage: jellyfish merge [options] input:string+ |
| 486 |
<p> |
| 487 |
Merge jellyfish databases |
| 488 |
<p> |
| 489 |
Options (default value in (), *required): |
| 490 |
<dl compact> |
| 491 |
<dt><b>-s</b>, |
| 492 |
<b>--buffer-size</b><i>=Buffer</i> |
| 493 |
</dt> |
| 494 |
<dd> length Length in bytes of input buffer (10000000) |
| 495 |
</dd> |
| 496 |
<dt><b>-o</b>, |
| 497 |
<b>--output</b><i>=string</i> |
| 498 |
</dt> |
| 499 |
<dd> Output file (mer_counts_merged.jf) |
| 500 |
</dd> |
| 501 |
<dt><b>--out-counter-len</b><i>=uint32</i> |
| 502 |
</dt> |
| 503 |
<dd> Length (in bytes) of counting field in output (4) |
| 504 |
</dd> |
| 505 |
<dt><b>--out-buffer-size</b><i>=uint64</i> |
| 506 |
</dt> |
| 507 |
<dd> Size of output buffer per thread (10000000) |
| 508 |
</dd> |
| 509 |
<dt><b>-v</b>,<b>--verbose</b> |
| 510 |
</dt> |
| 511 |
<dd> Be verbose (false) |
| 512 |
</dd> |
| 513 |
<dt><b>--usage</b> |
| 514 |
</dt> |
| 515 |
<dd> Usage |
| 516 |
</dd> |
| 517 |
<dt><b>-h</b>,<b>--help</b> |
| 518 |
</dt> |
| 519 |
<dd> This message |
| 520 |
</dd> |
| 521 |
<dt><b>-V</b>,<b>--version</b> |
| 522 |
</dt> |
| 523 |
<dd> Version |
| 524 |
</dd> |
| 525 |
</dl> |
| 526 |
<p> |
| 527 |
<h4><a name="section_13">query</a></h4> |
| 528 |
|
| 529 |
Usage: jellyfish query [options] db:path |
| 530 |
<p> |
| 531 |
Query from a compacted database |
| 532 |
<p> |
| 533 |
Query a hash. It reads k-mers from the standard input and write the counts on the standard output. |
| 534 |
<p> |
| 535 |
Options (default value in (), *required): |
| 536 |
<dl compact> |
| 537 |
<dt><b>-C</b>,<b>--both-strands</b> |
| 538 |
</dt> |
| 539 |
<dd> Both strands (false) |
| 540 |
</dd> |
| 541 |
<dt><b>-c</b>,<b>--cary-bit</b> |
| 542 |
</dt> |
| 543 |
<dd> Value field as the cary bit information (false) |
| 544 |
</dd> |
| 545 |
<dt><b>-i</b>, |
| 546 |
<b>--input</b><i>=file</i> |
| 547 |
</dt> |
| 548 |
<dd> Input file |
| 549 |
</dd> |
| 550 |
<dt><b>-o</b>, |
| 551 |
<b>--output</b><i>=file</i> |
| 552 |
</dt> |
| 553 |
<dd> Output file |
| 554 |
</dd> |
| 555 |
<dt><b>--usage</b> |
| 556 |
</dt> |
| 557 |
<dd> Usage |
| 558 |
</dd> |
| 559 |
<dt><b>-h</b>,<b>--help</b> |
| 560 |
</dt> |
| 561 |
<dd> This message |
| 562 |
</dd> |
| 563 |
<dt><b>-V</b>,<b>--version</b> |
| 564 |
</dt> |
| 565 |
<dd> Version |
| 566 |
</dd> |
| 567 |
</dl> |
| 568 |
<p> |
| 569 |
<h4><a name="section_14">qhisto</a></h4> |
| 570 |
|
| 571 |
Usage: jellyfish qhisto [options] db:string |
| 572 |
<p> |
| 573 |
Create an histogram of k-mer occurences |
| 574 |
<p> |
| 575 |
Options (default value in (), *required): |
| 576 |
<dl compact> |
| 577 |
<dt><b>-l</b>, |
| 578 |
<b>--low</b><i>=double</i> |
| 579 |
</dt> |
| 580 |
<dd> Low count value of histogram (0.0) |
| 581 |
</dd> |
| 582 |
<dt><b>-h</b>, |
| 583 |
<b>--high</b><i>=double</i> |
| 584 |
</dt> |
| 585 |
<dd> High count value of histogram (10000.0) |
| 586 |
</dd> |
| 587 |
<dt><b>-i</b>, |
| 588 |
<b>--increment</b><i>=double</i> |
| 589 |
</dt> |
| 590 |
<dd> Increment value for buckets (1.0) |
| 591 |
</dd> |
| 592 |
<dt><b>-f</b>,<b>--full</b> |
| 593 |
</dt> |
| 594 |
<dd> Full histo. Don't skip count 0. (false) |
| 595 |
</dd> |
| 596 |
<dt><b>--usage</b> |
| 597 |
</dt> |
| 598 |
<dd> Usage |
| 599 |
</dd> |
| 600 |
<dt><b>--help</b> |
| 601 |
</dt> |
| 602 |
<dd> This message |
| 603 |
</dd> |
| 604 |
<dt><b>-V</b>,<b>--version</b> |
| 605 |
</dt> |
| 606 |
<dd> Version |
| 607 |
</dd> |
| 608 |
</dl> |
| 609 |
<p> |
| 610 |
<h4><a name="section_15">qdump</a></h4> |
| 611 |
|
| 612 |
Usage: jellyfish qdump [options] db:path |
| 613 |
<p> |
| 614 |
Dump k-mer from a qmer database |
| 615 |
<p> |
| 616 |
By default, dump in a fasta format where the header is the count and |
| 617 |
the sequence is the sequence of the k-mer. The column format is a 2 |
| 618 |
column output: k-mer count. |
| 619 |
<p> |
| 620 |
Options (default value in (), *required): |
| 621 |
<dl compact> |
| 622 |
<dt><b>-c</b>,<b>--column</b> |
| 623 |
</dt> |
| 624 |
<dd> Column format (false) |
| 625 |
</dd> |
| 626 |
<dt><b>-t</b>,<b>--tab</b> |
| 627 |
</dt> |
| 628 |
<dd> Tab separator (false) |
| 629 |
</dd> |
| 630 |
<dt><b>-L</b>, |
| 631 |
<b>--lower-count</b><i>=double</i> |
| 632 |
</dt> |
| 633 |
<dd> Don't output k-mer with count < lower-count |
| 634 |
</dd> |
| 635 |
<dt><b>-U</b>, |
| 636 |
<b>--upper-count</b><i>=double</i> |
| 637 |
</dt> |
| 638 |
<dd> Don't output k-mer with count > upper-count |
| 639 |
</dd> |
| 640 |
<dt><b>-v</b>,<b>--verbose</b> |
| 641 |
</dt> |
| 642 |
<dd> Be verbose (false) |
| 643 |
</dd> |
| 644 |
<dt><b>-o</b>, |
| 645 |
<b>--output</b><i>=string</i> |
| 646 |
</dt> |
| 647 |
<dd> Output file |
| 648 |
</dd> |
| 649 |
<dt><b>--usage</b> |
| 650 |
</dt> |
| 651 |
<dd> Usage |
| 652 |
</dd> |
| 653 |
<dt><b>-h</b>,<b>--help</b> |
| 654 |
</dt> |
| 655 |
<dd> This message |
| 656 |
</dd> |
| 657 |
<dt><b>-V</b>,<b>--version</b> |
| 658 |
</dt> |
| 659 |
<dd> Version |
| 660 |
</dd> |
| 661 |
</dl> |
| 662 |
<p> |
| 663 |
<h4><a name="section_16">qmerge</a></h4> |
| 664 |
|
| 665 |
Usage: jellyfish merge [options] db:string+ |
| 666 |
<p> |
| 667 |
Merge quake databases |
| 668 |
<p> |
| 669 |
Options (default value in (), *required): |
| 670 |
<dl compact> |
| 671 |
<dt><b>-s</b>, |
| 672 |
<b>--size</b><i>=uint64</i> |
| 673 |
</dt> |
| 674 |
<dd> *Merged hash table size |
| 675 |
</dd> |
| 676 |
<dt><b>-m</b>, |
| 677 |
<b>--mer-len</b><i>=uint32</i> |
| 678 |
</dt> |
| 679 |
<dd> *Mer length |
| 680 |
</dd> |
| 681 |
<dt><b>-o</b>, |
| 682 |
<b>--output</b><i>=string</i> |
| 683 |
</dt> |
| 684 |
<dd> Output file (merged.jf) |
| 685 |
</dd> |
| 686 |
<dt><b>-p</b>, |
| 687 |
<b>--reprobes</b><i>=uint32</i> |
| 688 |
</dt> |
| 689 |
<dd> Maximum number of reprobes (62) |
| 690 |
</dd> |
| 691 |
<dt><b>--usage</b> |
| 692 |
</dt> |
| 693 |
<dd> Usage |
| 694 |
</dd> |
| 695 |
<dt><b>-h</b>,<b>--help</b> |
| 696 |
</dt> |
| 697 |
<dd> This message |
| 698 |
</dd> |
| 699 |
<dt><b>--full-help</b> |
| 700 |
</dt> |
| 701 |
<dd> Detailed help |
| 702 |
</dd> |
| 703 |
<dt><b>-V</b>,<b>--version</b> |
| 704 |
</dt> |
| 705 |
<dd> Version |
| 706 |
</dd> |
| 707 |
</dl> |
| 708 |
<p> |
| 709 |
<h4><a name="section_17">cite</a></h4> |
| 710 |
|
| 711 |
Usage: jellyfish cite [options] |
| 712 |
<p> |
| 713 |
How to cite Jellyfish's paper |
| 714 |
<p> |
| 715 |
Citation of paper |
| 716 |
<p> |
| 717 |
Options (default value in (), *required): |
| 718 |
<dl compact> |
| 719 |
<dt><b>-b</b>,<b>--bibtex</b> |
| 720 |
</dt> |
| 721 |
<dd> Bibtex format (false) |
| 722 |
</dd> |
| 723 |
<dt><b>-o</b>, |
| 724 |
<b>--output</b><i>=string</i> |
| 725 |
</dt> |
| 726 |
<dd> Output file |
| 727 |
</dd> |
| 728 |
<dt><b>--usage</b> |
| 729 |
</dt> |
| 730 |
<dd> Usage |
| 731 |
</dd> |
| 732 |
<dt><b>-h</b>,<b>--help</b> |
| 733 |
</dt> |
| 734 |
<dd> This message |
| 735 |
</dd> |
| 736 |
<dt><b>-V</b>,<b>--version</b> |
| 737 |
</dt> |
| 738 |
<dd> Version |
| 739 |
</dd> |
| 740 |
</dl> |
| 741 |
<p> |
| 742 |
<h2><a name="section_18">Version</a></h2> |
| 743 |
|
| 744 |
<p> |
| 745 |
Version: 1.1.4 of 2010/10/1 |
| 746 |
<p> |
| 747 |
<h2><a name="section_19">Bugs</a></h2> |
| 748 |
|
| 749 |
<p> |
| 750 |
<ul compact> |
| 751 |
<li><tt>jellyfish merge</tt> has not been parallelized and is |
| 752 |
relatively slow. |
| 753 |
</li> |
| 754 |
<li>The hash table does not grow in memory automatically and |
| 755 |
<tt>jellyfish merge</tt> |
| 756 |
is not called automatically on the |
| 757 |
intermediary files (if any). |
| 758 |
</li> |
| 759 |
</ul> |
| 760 |
<p> |
| 761 |
<h2><a name="section_20">Copyright & License</a></h2> |
| 762 |
|
| 763 |
<dl compact> |
| 764 |
<dt>Copyright</dt> |
| 765 |
<dd> © 2010, Guillaume Marcais <a href ="mailto:[email protected]"><tt>[email protected]</tt></a> |
| 766 |
and Carl Kingsford <a href ="mailto:[email protected]"><tt>[email protected]</tt></a>. |
| 767 |
<p> |
| 768 |
</dd> |
| 769 |
<dt>License</dt> |
| 770 |
<dd> This program is free software: you can redistribute it |
| 771 |
and/or modify it under the terms of the GNU General Public License |
| 772 |
as published by the Free Software Foundation, either version 3 of |
| 773 |
the License, or (at your option) any later version. <br> |
| 774 |
|
| 775 |
This program is distributed in the hope that it will be useful, but |
| 776 |
WITHOUT ANY WARRANTY; without even the implied warranty of |
| 777 |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 778 |
General Public License for more details. <br> |
| 779 |
|
| 780 |
You should have received a copy of the GNU General Public License |
| 781 |
along with this program. If not, see |
| 782 |
<a href ="http://www.gnu.org/licenses/"><tt>http://www.gnu.org/licenses/</tt></a>. |
| 783 |
</dd> |
| 784 |
</dl> |
| 785 |
<p> |
| 786 |
<h2><a name="section_21">Authors</a></h2> |
| 787 |
|
| 788 |
Guillaume Marcais <br> |
| 789 |
|
| 790 |
University of Maryland <br> |
| 791 |
|
| 792 |
<a href ="mailto:[email protected]"><tt>[email protected]</tt></a> |
| 793 |
<p> |
| 794 |
Carl Kingsford <br> |
| 795 |
|
| 796 |
University of Maryland <br> |
| 797 |
|
| 798 |
<a href ="mailto:[email protected]"><tt>[email protected]</tt></a> |
| 799 |
<p> |
| 800 |
</body> |
| 801 |
</html> |
| 802 |
<!-- NOTE: This file is generated, DO NOT EDIT. --> |