Adds optional arguments to report k-best alignments with a NH tag#499
Open
milkschen wants to merge 5 commits into
Open
Adds optional arguments to report k-best alignments with a NH tag#499milkschen wants to merge 5 commits into
milkschen wants to merge 5 commits into
Conversation
The `NH:i` tag reports "Number of reported alignments that contain the query in the current record" per [SAM spec]( https://samtools.github.io/hts-specs/SAMtags.pdf). It is useful when multiple alignments can be reported for one query.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Design
This PR describes two new input, optional arguments for
bowtie2-align:--kbest. This argument is expected to be used along with the-kalignment mode to report up tokalignments, with a constraint that all reported alignments share the same alignment score with the primary alignment.--show-nh-tag. When this is set, shows theNH:itag to report the number of alignments of a query. This is particularly useful in the-k/-amodes.The changes should not change the default
bowtie2-alignbehaviors, at least in my test runs.Test case
FASTQ (two tRNA sequences):
Resulting SAM mapped to chm13v2 with
-k 3(changes in this PR would not affect this run):Resulting SAM mapped to chm13v2 with
-k 3 --kbest:Resulting SAM mapped to chm13v2 with
-k 3 --kbest --show-nh-tag: