Skip to content

Commit dd90d9d

Browse files
committed
caution that the splice:sr is experimental
1 parent cbe8d61 commit dd90d9d

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ cd minimap2 && make
2121
./minimap2 -ax splice -uf -k14 ref.fa reads.fa > aln.sam # noisy Nanopore direct RNA-seq
2222
./minimap2 -ax splice:hq -uf ref.fa query.fa > aln.sam # PacBio Kinnex/Iso-seq (RNA-seq)
2323
./minimap2 -ax splice --junc-bed anno.bed12 ref.fa query.fa > aln.sam # use annotated junctions
24-
./minimap2 -ax splice:sr ref.fa r1.fq r2.fq > aln.sam # short-read RNA-seq (r1236 or later)
24+
./minimap2 -ax splice:sr ref.fa r1.fq r2.fq > aln.sam # short-read RNA-seq (r1236+; experimental)
2525
./minimap2 -cx asm5 asm1.fa asm2.fa > aln.paf # intra-species asm-to-asm alignment
2626
./minimap2 -x ava-pb reads.fa reads.fa > overlaps.paf # PacBio read overlap
2727
./minimap2 -x ava-ont reads.fa reads.fa > overlaps.paf # Nanopore read overlap
@@ -40,7 +40,7 @@ man ./minimap2.1
4040
- [Map long mRNA/cDNA reads](#map-long-splice)
4141
- [Find overlaps between long reads](#long-overlap)
4242
- [Map short genomic reads](#short-genomic)
43-
- [Map short RNA-seq reads](#short-rna-seq)
43+
- [Map short RNA-seq reads (experimental & evolving)](#short-rna-seq)
4444
- [Full genome/assembly alignment](#full-genome)
4545
- [Advanced features](#advanced)
4646
- [Working with >65535 CIGAR operations](#long-cigar)
@@ -231,14 +231,16 @@ be paired if they are adjacent in the input stream and have the same name (with
231231
the `/[0-9]` suffix trimmed if present). Single- and paired-end reads can be
232232
mixed.
233233

234-
#### <a name="short-rna-seq"></a>Map short RNA-seq reads
234+
#### <a name="short-rna-seq"></a>Map short RNA-seq reads (experimental & evolving)
235235

236236
```sh
237237
minimap2 -ax splice:sr ref.fa reads-se.fq > aln.sam # single-end
238238
minimap2 -ax splice:sr ref.fa r1.fq r2.fq > aln.sam # paired-end
239239
```
240240
The new preset `splice:sr` was added between v2.28 and v2.29. It functions
241-
similarly to `sr` except that it performs spliced alignment.
241+
similarly to `sr` except that it performs spliced alignment. Note that this
242+
functionality is ***experiemental*** and evolving. It is better not to use it
243+
for production.
242244

243245
#### <a name="full-genome"></a>Full genome/assembly alignment
244246

0 commit comments

Comments
 (0)