Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ADAM-1465] Updating realigner CLI docs. #1466

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/source/50_cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,15 @@ options fall into several general categories:
* `-max_target_size`: The maximum length of a target to realign. Targets
longer than this size are dropped before trying to realign. Defaults to
3,000bp.
* `-max_reads_per_target`: The maximum number of reads in a target that
we will try to realign. By default, this value is 20,000 reads. If we
encounter a target with more than this number of reads, we skip realigning
this target.
* `-reference`: An optional path to a reference genome assembly build. If this
is not provided, then we attempt to reconstruct the reference at each target
from the MD tags on each read.
* `-unclip_reads`: If provided, we will unclip reads when attempting to realign
them to the reference. If not provided, we leave clipped reads clipped.
* `-log_odds_threshold`: The log odds threshold to use for picking a
consensus sequence to finalize realignments against. A consensus will not
be realigned against unless the Phred weighted edit distance against the
Expand Down