Deleting / archiving no longer classes

-- AminoAcidTable and AminoAcid goes to the archive
-- Removing two unused SAMRecord classes
This commit is contained in:
Mark DePristo 2012-12-29 14:34:17 -05:00
parent 38cc496de8
commit 5558a6b8f7
4 changed files with 0 additions and 435 deletions

View File

@ -1,60 +0,0 @@
/*
* The MIT License
*
* Copyright (c) 2009 The Broad Institute
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package org.broadinstitute.sting.gatk.walkers.indels;
import net.sf.samtools.SAMRecord;
import net.sf.samtools.SAMRecordCoordinateComparator;
/**
* Extends Picard's Comparator for sorting SAMRecords by coordinate. This one actually deals with unmapped reads
* (among other things) sitting at the same position as their mates (so that they both can be put into the same set).
*/
public class SAMRecordCoordinateComparatorWithUnmappedReads extends SAMRecordCoordinateComparator {
public int compare(final SAMRecord samRecord1, final SAMRecord samRecord2) {
int cmp = fileOrderCompare(samRecord1, samRecord2);
if ( cmp != 0 )
return cmp;
// deal with unmapped reads
if ( samRecord1.getReadUnmappedFlag() != samRecord2.getReadUnmappedFlag() )
return (samRecord1.getReadUnmappedFlag()? 1: -1);
if ( samRecord1.getReadNegativeStrandFlag() != samRecord2.getReadNegativeStrandFlag() )
return (samRecord1.getReadNegativeStrandFlag()? 1: -1);
// even the names can be the same
cmp = samRecord1.getReadName().compareTo(samRecord2.getReadName());
if ( cmp != 0 )
return cmp;
if ( samRecord1.getDuplicateReadFlag() != samRecord2.getDuplicateReadFlag() )
return (samRecord1.getDuplicateReadFlag()? -1: 1);
if ( samRecord1.getReadPairedFlag() && samRecord2.getReadPairedFlag() && samRecord1.getFirstOfPairFlag() != samRecord2.getFirstOfPairFlag() )
return (samRecord1.getFirstOfPairFlag()? -1: 1);
// such a case was actually observed
return samRecord1.getMappingQuality() - samRecord2.getMappingQuality();
}
}

View File

@ -1,93 +0,0 @@
/*
* Copyright (c) 2010 The Broad Institute
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
* THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.broadinstitute.sting.utils;
/**
* Represents a single amino acid.
*/
public class AminoAcid {
private String name;
private String threeLetterCode;
private String letter;
/**
* Constructor.
*
* @param letter The 1 letter code. (eg. I). This is '*' for the stop codon.
* @param name The full name of the AA (eg. Isoleucine).
* @param code The 3 letter code. (eg. Ile).
*/
public AminoAcid( String letter, String name, String code) {
this.name = name;
this.threeLetterCode = code;
this.letter = letter;
}
/** Equality based on the amino acid code. */
public boolean equals(Object o) {
if (this == o) { return true; }
if (o == null || !(o instanceof AminoAcid)) { return false; }
final AminoAcid aminoAcid = (AminoAcid) o;
return !(getCode() != null ? !getCode().equals(aminoAcid.getCode()) : aminoAcid.getCode() != null);
}
/** Hashes the three letter code. */
public int hashCode() {
return (getCode() != null ? getCode().hashCode() : 0);
}
/**
* Returns the full name of this AA.
*/
public String getName() { return name; }
/**
* Returns the 1 letter code for this AA.
*/
public String getLetter() { return letter; }
/**
* Returns the 3 letter code.
*/
public String getCode() { return threeLetterCode; }
/** Returns true if the amino acid is really just a stop codon. */
public boolean isStop() {
return "*".equals(getLetter());
}
/** Returns true if the amino acid is really just a stop codon. */
public boolean isUnknown() {
return "X".equals(getLetter());
}
public String toString() {
return name;
}
}

View File

@ -1,214 +0,0 @@
/*
* Copyright (c) 2010 The Broad Institute
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
* THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.broadinstitute.sting.utils;
import java.util.HashMap;
/**
* A simple {codon -> amino acid name} lookup table.
* Handles differences between mitochondrial and nuclear genes.
*/
public class AminoAcidTable {
protected static final AminoAcid UNKNOWN = new AminoAcid("X" , "Unknown", "Unk");
protected static final AminoAcid ISOLEUCINE = new AminoAcid("I" , "Isoleucine", "Ile");
protected static final AminoAcid LEUCINE = new AminoAcid("L" , "Leucine", "Leu");
protected static final AminoAcid VALINE = new AminoAcid("V" , "Valine", "Val");
protected static final AminoAcid PHENYLALANINE = new AminoAcid("F" , "Phenylalanine", "Phe");
protected static final AminoAcid METHIONINE = new AminoAcid("M" , "Methionine", "Met");
protected static final AminoAcid CYSTEINE = new AminoAcid("C" , "Cysteine", "Cys");
protected static final AminoAcid ALANINE = new AminoAcid("A" , "Alanine", "Ala");
protected static final AminoAcid STOP_CODON = new AminoAcid("*" , "Stop Codon", "Stop");
protected static final AminoAcid GLYCINE = new AminoAcid("G" , "Glycine", "Gly");
protected static final AminoAcid PROLINE = new AminoAcid("P" , "Proline", "Pro");
protected static final AminoAcid THEONINE = new AminoAcid("T" , "Threonine", "Thr");
protected static final AminoAcid SERINE = new AminoAcid("S" , "Serine", "Ser");
protected static final AminoAcid TYROSINE = new AminoAcid("Y" , "Tyrosine", "Tyr");
protected static final AminoAcid TRYPTOPHAN = new AminoAcid("W" , "Tryptophan", "Trp");
protected static final AminoAcid GLUTAMINE = new AminoAcid("Q" , "Glutamine", "Gln");
protected static final AminoAcid ASPARAGINE = new AminoAcid("N" , "Asparagine", "Asn");
protected static final AminoAcid HISTIDINE = new AminoAcid("H" , "Histidine", "His");
protected static final AminoAcid GLUTAMIC_ACID = new AminoAcid("E" , "Glutamic acid", "Glu");
protected static final AminoAcid ASPARTIC_ACID = new AminoAcid("D" , "Aspartic acid", "Asp");
protected static final AminoAcid LYSINE = new AminoAcid("K" , "Lysine", "Lys");
protected static final AminoAcid ARGININE = new AminoAcid("R" , "Arginine", "Arg");
protected static HashMap<String, AminoAcid> aminoAcidTable = new HashMap<String, AminoAcid>();
protected static HashMap<String, AminoAcid> mitochondrialAminoAcidTable = new HashMap<String, AminoAcid>();
static {
//populate the tables
aminoAcidTable.put("ATT", ISOLEUCINE);
aminoAcidTable.put("ATC", ISOLEUCINE);
aminoAcidTable.put("ATA", ISOLEUCINE);
aminoAcidTable.put("CTT", LEUCINE);
aminoAcidTable.put("CTC", LEUCINE);
aminoAcidTable.put("CTA", LEUCINE);
aminoAcidTable.put("CTG", LEUCINE);
aminoAcidTable.put("TTA", LEUCINE);
aminoAcidTable.put("TTG", LEUCINE);
aminoAcidTable.put("GTT", VALINE);
aminoAcidTable.put("GTC", VALINE);
aminoAcidTable.put("GTA", VALINE);
aminoAcidTable.put("GTG", VALINE);
aminoAcidTable.put("TTT", PHENYLALANINE);
aminoAcidTable.put("TTC", PHENYLALANINE);
aminoAcidTable.put("ATG", METHIONINE);
aminoAcidTable.put("TGT", CYSTEINE);
aminoAcidTable.put("TGC", CYSTEINE);
aminoAcidTable.put("GCT", ALANINE);
aminoAcidTable.put("GCC", ALANINE);
aminoAcidTable.put("GCA", ALANINE);
aminoAcidTable.put("GCG", ALANINE);
aminoAcidTable.put("GGT", GLYCINE);
aminoAcidTable.put("GGC", GLYCINE);
aminoAcidTable.put("GGA", GLYCINE);
aminoAcidTable.put("GGG", GLYCINE);
aminoAcidTable.put("CCT", PROLINE);
aminoAcidTable.put("CCC", PROLINE);
aminoAcidTable.put("CCA", PROLINE);
aminoAcidTable.put("CCG", PROLINE);
aminoAcidTable.put("ACT", THEONINE);
aminoAcidTable.put("ACC", THEONINE);
aminoAcidTable.put("ACA", THEONINE);
aminoAcidTable.put("ACG", THEONINE);
aminoAcidTable.put("TCT", SERINE);
aminoAcidTable.put("TCC", SERINE);
aminoAcidTable.put("TCA", SERINE);
aminoAcidTable.put("TCG", SERINE);
aminoAcidTable.put("AGT", SERINE);
aminoAcidTable.put("AGC", SERINE);
aminoAcidTable.put("TAT", TYROSINE);
aminoAcidTable.put("TAC", TYROSINE);
aminoAcidTable.put("TGG", TRYPTOPHAN);
aminoAcidTable.put("CAA", GLUTAMINE);
aminoAcidTable.put("CAG", GLUTAMINE);
aminoAcidTable.put("AAT", ASPARAGINE);
aminoAcidTable.put("AAC", ASPARAGINE);
aminoAcidTable.put("CAT", HISTIDINE);
aminoAcidTable.put("CAC", HISTIDINE);
aminoAcidTable.put("GAA", GLUTAMIC_ACID);
aminoAcidTable.put("GAG", GLUTAMIC_ACID);
aminoAcidTable.put("GAT", ASPARTIC_ACID);
aminoAcidTable.put("GAC", ASPARTIC_ACID);
aminoAcidTable.put("AAA", LYSINE);
aminoAcidTable.put("AAG", LYSINE);
aminoAcidTable.put("CGT", ARGININE);
aminoAcidTable.put("CGC", ARGININE);
aminoAcidTable.put("CGA", ARGININE);
aminoAcidTable.put("CGG", ARGININE);
aminoAcidTable.put("AGA", ARGININE);
aminoAcidTable.put("AGG", ARGININE);
aminoAcidTable.put("TAA", STOP_CODON );
aminoAcidTable.put("TAG", STOP_CODON);
aminoAcidTable.put("TGA", STOP_CODON);
//populate the mitochondrial AA table
mitochondrialAminoAcidTable.putAll(aminoAcidTable);
mitochondrialAminoAcidTable.put("AGA", STOP_CODON);
mitochondrialAminoAcidTable.put("AGG", STOP_CODON);
mitochondrialAminoAcidTable.put("ATA", METHIONINE);
mitochondrialAminoAcidTable.put("TGA", TRYPTOPHAN);
}
/**
* Returns the amino acid encoded by the given codon in a eukaryotic genome.
*
* @param codon The 3-letter mRNA nucleotide codon 5' to 3'. Expects T's instead of U's. Not case sensitive.
*
* @return The amino acid matching the given codon, or the UNKNOWN amino acid if the codon string doesn't match anything
*/
public static AminoAcid getEukaryoticAA(String codon) {
codon = codon.toUpperCase();
final AminoAcid aa = aminoAcidTable.get(codon);
return aa == null ? UNKNOWN : aa;
}
/**
* Returns the amino acid encoded by the given codon in a mitochondrial genome.
*
* @param codon The 3-letter mRNA nucleotide codon 5' to 3'. Expects T's instead of U's. Not case sensitive.
* @param isFirstCodon If this is the 1st codon in the gene, then "ATT" encodes Methyonine
*
* @return The amino acid matching the given codon in mitochondrial genes, or the UNKNOWN amino acid if the codon string doesn't match anything
*/
public static AminoAcid getMitochondrialAA(String codon, boolean isFirstCodon) {
codon = codon.toUpperCase();
final AminoAcid aa = mitochondrialAminoAcidTable.get(codon);
if(aa == null) {
return UNKNOWN;
} else if(isFirstCodon && codon.equals("ATT")) {
return METHIONINE; //special case - 'ATT' in the first codon of a mitochondrial gene codes for methionine instead of isoleucine
} else {
return aa;
}
}
}

View File

@ -1,68 +0,0 @@
/*
* Copyright (c) 2010 The Broad Institute
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
* THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.broadinstitute.sting.utils.sam;
import net.sf.samtools.SAMRecord;
public class ComparableSAMRecord implements Comparable<ComparableSAMRecord> {
private SAMRecord record;
public ComparableSAMRecord(SAMRecord record) {
this.record = record;
}
public SAMRecord getRecord() {
return record;
}
public int compareTo(ComparableSAMRecord o) {
// first sort by start position -- with not coverflow because both are guaranteed to be positive.
int comparison = record.getAlignmentStart() - o.record.getAlignmentStart();
// if the reads have the same start position, we must give a non-zero comparison
// (because java Sets often require "consistency with equals")
if ( comparison == 0 )
comparison = record.getReadName().compareTo(o.getRecord().getReadName());
// if the read names are the same, use the first of the pair if appropriate
if ( comparison == 0 && record.getReadPairedFlag() )
comparison = ( record.getFirstOfPairFlag() ? -1 : 1);
return comparison;
}
public boolean equals(Object obj) {
if ( !(obj instanceof ComparableSAMRecord) )
return false;
if ( this == obj )
return true;
ComparableSAMRecord csr = (ComparableSAMRecord)obj;
if(record.getAlignmentStart() != csr.record.getAlignmentStart())
return false;
if ( !record.getReadName().equals(csr.getRecord().getReadName()) )
return false;
return ( record.getFirstOfPairFlag() == csr.record.getFirstOfPairFlag() );
}
}