From c4ac0fa3d46456eb0f9692802996fba3f44e45eb Mon Sep 17 00:00:00 2001 From: infphilo Date: Thu, 3 Nov 2016 08:16:59 -0400 Subject: [PATCH] manual update --- MANUAL | 4 ++++ doc/manual.inc.html | 10 +++++++++- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/MANUAL b/MANUAL index bda4731f..ba1e8d6e 100644 --- a/MANUAL +++ b/MANUAL @@ -567,6 +567,10 @@ reported read or pair alignment beyond the first has the SAM 'secondary' bit Note: HISAT2 is not designed with large values for `-k` in mind, and when aligning reads to long, repetitive genomes large `-k` can be very, very slow. + --max-seeds + +HISAT2, like other aligners, uses seed-and-extend approaches. HISAT2 tries to extend seeds to full-length alignments. In HISAT2, --max-seeds is used to control the maximum number of seeds that will be extended. HISAT2 extends up to these many seeds and skips the rest of the seeds. Large values for `--max-seeds` may improve alignment sensitivity, but HISAT2 is not designed with large values for `--max-seeds` in mind, and when aligning reads to long, repetitive genomes large `--max-seeds` can be very, very slow. The default value is the same as with `-k`. + --secondary Report secondary alignments. diff --git a/doc/manual.inc.html b/doc/manual.inc.html index 3ae0eaab..59daf71d 100644 --- a/doc/manual.inc.html +++ b/doc/manual.inc.html @@ -468,7 +468,15 @@

Reporting options

It searches for at most <int> distinct, primary alignments for each read. Primary alignments mean alignments whose alignment score is equal or higher than any other alignments. The search terminates when it can't find more distinct valid alignments, or when it finds <int>, whichever happens first. The alignment score for a paired-end alignment equals the sum of the alignment scores of the individual mates. Each reported read or pair alignment beyond the first has the SAM 'secondary' bit (which equals 256) set in its FLAGS field. For reads that have more than <int> distinct, valid alignments, hisat2 does not guarantee that the <int> alignments reported are the best possible in terms of alignment score. Default: 5 (HFM) or 10 (HGFM)

Note: HISAT2 is not designed with large values for -k in mind, and when aligning reads to long, repetitive genomes large -k can be very, very slow.

- + + +
--max-seeds <int>
+ + +

HISAT2, like other aligners, uses seed-and-extend approaches. HISAT2 tries to extend seeds to full-length alignments. In HISAT2, --max-seeds is used to control the maximum number of seeds that will be extended. HISAT2 extends up to these many seeds and skips the rest of the seeds. Large values for --max-seeds may improve alignment sensitivity, but HISAT2 is not designed with large values for --max-seeds in mind, and when aligning reads to long, repetitive genomes large --max-seeds can be very, very slow. The default value is the same as with -k.

+ + + 
--secondary