Skip to content

Commit

Permalink
Merge branch 'aligner_docs_update' into 'master'
Browse files Browse the repository at this point in the history
aligner: updated the docs to reflect the new default lr:hq parameters

See merge request machine-learning/dorado!974
  • Loading branch information
tijyojwad committed Apr 29, 2024
2 parents ebc32f1 + 412bc6b commit eaf4ab2
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ To basecall with alignment with duplex or simplex, run with the `--reference` op
$ dorado basecaller <model> <reads> --reference <index> > calls.bam
```

Alignment uses [minimap2](https://github.com/lh3/minimap2) and by default uses the `map-ont` preset. This can be overridden with the `-k` and `-w` options to set kmer and window size respectively.
Alignment uses [minimap2](https://github.com/lh3/minimap2) and by default uses the `lr:hq` preset. This can be overridden with the `--mm2-preset` option or using `-k` and `-w` options to set kmer and window size respectively.

### Sequencing Summary

Expand Down
2 changes: 1 addition & 1 deletion dorado/cli/aligner.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ int aligner(int argc, char* argv[]) {
cli::ArgParser parser("dorado aligner");
parser.visible.add_description(
"Alignment using minimap2. The outputs are expected to be equivalent to minimap2.\n"
"The default parameters use the map-ont preset.\n"
"The default parameters use the lr:hq preset.\n"
"NOTE: Not all arguments from minimap2 are currently available. Additionally, "
"parameter names are not finalized and may change.");
parser.visible.add_argument("index").help("reference in (fastq/fasta/mmi).");
Expand Down

0 comments on commit eaf4ab2

Please sign in to comment.