Skip to content

Commit

Permalink
Explain missing be tags in SvPileup
Browse files Browse the repository at this point in the history
  • Loading branch information
nh13 authored Oct 4, 2023
1 parent f55b599 commit 994cece
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion src/main/scala/com/fulcrumgenomics/sv/tools/SvPileup.scala
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ object TargetBedRequirement extends FgBioEnum[TargetBedRequirement] {
|2. `<output-prefix>.bam`: a SAM/BAM file containing reads that contain SV breakpoint evidence annotated with SAM
| tag.
|
|The `be` SAM tag contains a comma-delimited list of breakpoints to which a given read belongs. Each element is
|The `be` SAM tag contains a comma-delimited list of breakpoints to which a given alignment belongs. Each element is
|a semi-colon delimited, with four fields:
|
|1. The unique breakpoint identifier (same identifier found in the tab-delimited output).
Expand All @@ -64,6 +64,11 @@ object TargetBedRequirement extends FgBioEnum[TargetBedRequirement] {
|4. The type of breakpoint evidence: either "split_read" for observations of an aligned segment of a single read
| with split alignments, or "read_pair" for observations _between_ reads in a read pair.
|
|As described in the Algorithm Overview below, split-read evidence is favored over across-read-pair evidence.
|Therefore, if the template (alignments for a read pair) contain both types of evidence, then the `be` tag
|will only be added to the split-read alignments (i.e. the primary and supplementary alignments of the read
|in the pair that has split-read evidence), and will not be found in the mate's alignment.
|
|## Example output
|
|The following shows two breakpoints:
Expand Down

0 comments on commit 994cece

Please sign in to comment.