htsjdk.samtools

Class SAMRecordDuplicateComparator

java.lang.Object

htsjdk.samtools.SAMRecordDuplicateComparator

All Implemented Interfaces:

SAMRecordComparator, java.io.Serializable, java.util.Comparator<SAMRecord>

public class SAMRecordDuplicateComparator
extends java.lang.Object
implements SAMRecordComparator, java.io.Serializable

Compares records based on if they should be considered PCR Duplicates (see MarkDuplicates). There are three orderings provided by this comparator: compare, duplicateSetCompare, and fileOrderCompare. Specify the headers when constructing this comparator if you would like to consider the library as the major sort key. The records being compared must also have non-null SAMFileHeaders.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	UNKNOWN_LIBRARY_STRING

Constructor Summary

Constructors

Constructor and Description
SAMRecordDuplicateComparator()
SAMRecordDuplicateComparator(java.util.List<SAMFileHeader> headers) Deprecated.
SAMRecordDuplicateComparator(SAMFileHeader header)

Method Summary

Modifier and Type	Method and Description
int	compare(SAMRecord samRecord1, SAMRecord samRecord2) Most stringent comparison.
int	duplicateSetCompare(SAMRecord samRecord1, SAMRecord samRecord2) Less stringent than compare, such that two records are equal enough such that their ordering within their duplicate set would be arbitrary.
int	fileOrderCompare(SAMRecord samRecord1, SAMRecord samRecord2) Less stringent than duplicateSetCompare, such that two records are equal enough such that their ordering in a sorted SAM file would be arbitrary.
void	setScoringStrategy(DuplicateScoringStrategy.ScoringStrategy scoringStrategy)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Field Detail

UNKNOWN_LIBRARY_STRING

public static final java.lang.String UNKNOWN_LIBRARY_STRING

See Also:

Constant Field Values

Constructor Detail

SAMRecordDuplicateComparator

public SAMRecordDuplicateComparator()

SAMRecordDuplicateComparator

@Deprecated
public SAMRecordDuplicateComparator(java.util.List<SAMFileHeader> headers)

Deprecated.

SAMRecordDuplicateComparator

public SAMRecordDuplicateComparator(SAMFileHeader header)

Method Detail

setScoringStrategy

public void setScoringStrategy(DuplicateScoringStrategy.ScoringStrategy scoringStrategy)

compare

public int compare(SAMRecord samRecord1,
                   SAMRecord samRecord2)

Most stringent comparison. Two records are compared based on if they are duplicates of each other, and then based on if they should be prioritized for being the most "representative". Typically, the representative is the record in the SAM file that is *not* marked as a duplicate within a set of duplicates. Compare by file order, then duplicate scoring strategy, read name. If both reads are paired and both ends mapped, always prefer the first end over the second end. This is needed to properly choose the first end for optical duplicate identification when both ends are mapped to the same position etc.

Specified by:

compare in interface java.util.Comparator<SAMRecord>

duplicateSetCompare

public int duplicateSetCompare(SAMRecord samRecord1,
                               SAMRecord samRecord2)

Less stringent than compare, such that two records are equal enough such that their ordering within their duplicate set would be arbitrary. Major difference between this and fileOrderCompare is how we compare the orientation byte. Here we want: F == FR, F == FF R == RF, R == RR

fileOrderCompare

public int fileOrderCompare(SAMRecord samRecord1,
                            SAMRecord samRecord2)

Less stringent than duplicateSetCompare, such that two records are equal enough such that their ordering in a sorted SAM file would be arbitrary.

Specified by:

fileOrderCompare in interface SAMRecordComparator

Returns:

negative if samRecord1 < samRecord2, 0 if equal, else positive