Skip to content

Commit 5086938

Browse files
authored
Merge pull request #364 from DaehwanKimLab/master_webpage_update
update hisat-3n webpage for directional mapping mode
2 parents c4419f9 + dc46349 commit 5086938

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

docs/_pages/hisat-3n.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ The repeat mode can align nucleotide conversion reads more accurately,
2020
and it is only 10% slower than the standard mode with tiny more memory (repeat mode use about ~10.5GB) usage than the standard mode.
2121

2222
HISAT-3N is developed based on [HISAT2], which is particularly optimized for RNA sequencing technology.
23+
HISAT-3N supports both strand-specific and non-strand reads.
2324
HISAT-3N can be used for any base-converted sequencing reads include [BS-seq], [SLAM-seq], [TAB-seq], [oxBS-seq], [TAPS], [scBS-seq], and [scSLAM-seq].
2425

2526
[HISAT2]:https://github.com/DaehwanKimLab/hisat2
@@ -121,6 +122,10 @@ HISAT-3N uses the HISAT2 argument but has some extra arguments. Please check [HI
121122
The index for HISAT-3N. The basename is the name of the index files up to but not including the suffix `.3n.*.*.ht2` / etc.
122123
For example, you build your index with basename 'genome' by HISAT-3N-build, please enter `-x genome`.
123124

125+
* `--directional-mapping`
126+
Make directional mapping. Please use this option only if your sequencing reads are generated from a strand-specific library.
127+
The directional mapping mode is about 2x faster than the default (non-directional) mapping mode.
128+
124129
* `--repeat-limit <int>`
125130
You can set up the number of alignment will be checked for each repeat alignment. You may increase the number to let hisat-3n
126131
output more, if a read has multiple mapping. We suggest the repeat limit number for paired-end reads alignment is no more
@@ -134,8 +139,8 @@ HISAT-3N uses the HISAT2 argument but has some extra arguments. Please check [HI
134139
# Single-end slam-seq reads (T to C conversion, RNA) alignment with the standard 3N-index:
135140
hisat-3n -x genome -f -U read.fa -S alignment_result.sam --base-change T,C --no-repeat-index
136141

137-
# Paired-end bisulfite-seq reads (C to T conversion, DNA) alignment with the repeat 3N-index:
138-
hisat-3n -x genome -f -1 read_1.fa -2 read_2.fa -S alignment_result.sam --base-change C,T --repeat --no-spliced-alignment
142+
# Paired-end strand-specific bisulfite-seq read (C to T conversion) alignment with repeat 3N-index:
143+
hisat-3n -x genome -f -1 read_1.fa -2 read_2.fa -S alignment_result.sam --base-change C,T --repeat --no-spliced-alignment --directional-mapping
139144

140145
# Single-end TAPS reads (have C to T conversion, RNA) alignment with the repeat 3N-index:
141146
hisat-3n -x genome -q -U read.fq -S alignment_result.sam --base-change C,T --repeat

0 commit comments

Comments
 (0)