keep documents in sync

This commit is contained in:
Heng Li
2018-02-15 17:21:09 -05:00
parent 8fc5f8dc90
commit 54a42aafe5
2 changed files with 23 additions and 25 deletions
+7 -20
View File
@@ -38,7 +38,7 @@ man ./minimap2.1
- [Advanced features](#advanced)
- [Working with >65535 CIGAR operations](#long-cigar)
- [The cs optional tag](#cs)
- [Evaluation scripts](#eval)
- [Working with the PAF format](#paftools)
- [Algorithm overview](#algo)
- [Getting help](#help)
- [Citing minimap2](#cite)
@@ -256,26 +256,13 @@ the alignment. The above example will become
`=CGATCG-ata=AATAGAGTAG+gtc=GAAT*at=GCA`. The long form of `cs` encodes both
reference and query sequences in one string.
#### <a name="eval"></a>Evaluation scripts
#### <a name="paftools"></a>Working with the PAF format
Minimap2 comes with several (java)scripts for evaluating the accuracy of
minimap2. These scripts require the [k8][k8] javascript shell to run.
Recent minimap2 binary release tar-balls contain a copy of k8 executable, a
single file. Here are a few examples on how to use these scripts:
```sh
# Generate reads from PBSIM alignment (truth encoded in read names)
k8 misc/sim-pbsim.js ref.fa.fai pbsim-aln.maf > pbsim-reads.fq
# Generate reads from mason2 alignment (not tested for simulated SVs)
k8 misc/sim-mason2.js mason2-aln.sam > mason2-reads.fq
# Evaluate mapping accuracy with ROC-like curve
k8 misc/sim-eval.js my-aln.sam.gz > result.txt
k8 misc/sim-eval.js my-aln.paf.gz > result.txt
# Collect alignment statistics
k8 misc/mapstat.js my-aln.sam > result.txt
# Compare spliced junctions to existing gene annotations
k8 misc/intron-eval.js anno.gtf my-spliced-aln.sam > result.txt
```
Minimap2 also comes with a (java)script [paftools.js](misc/paftools.js) that
processes alignments in the PAF format. It calls variants from
assembly-to-reference alignment, lifts over BED files based on alignment,
converts between formats and provides utilities for various evaluations. For
details, please see [misc/README.md](misc/README.md).
### <a name="algo"></a>Algorithm overview