import jalview.datamodel.SequenceI;
+import java.util.ArrayList;
+import java.util.List;
+
/**
* Assorted methods for analysing or comparing sequences.
*/
private static final int TO_UPPER_CASE = 'a' - 'A';
- private static final char GAP_SPACE = ' ';
+ public static final char GAP_SPACE = ' ';
- private static final char GAP_DOT = '.';
+ public static final char GAP_DOT = '.';
- private static final char GAP_DASH = '-';
+ public static final char GAP_DASH = '-';
- public static final String GapChars = new String(new char[]
- { GAP_SPACE, GAP_DOT, GAP_DASH });
+ public static final String GapChars = new String(
+ new char[]
+ { GAP_SPACE, GAP_DOT, GAP_DASH });
/**
* DOCUMENT ME!
* int
* @return float
*/
- public static float compare(SequenceI ii, SequenceI jj, int start, int end)
+ public static float compare(SequenceI ii, SequenceI jj, int start,
+ int end)
{
String si = ii.getSequenceAsString();
String sj = jj.getSequenceAsString();
{
for (int j = 0; j < jlen; j++)
{
- if (si.substring(start + j, start + j + 1).equals(
- sj.substring(start + j, start + j + 1)))
+ if (si.substring(start + j, start + j + 1)
+ .equals(sj.substring(start + j, start + j + 1)))
{
match++;
}
{
for (int j = 0; j < jlen; j++)
{
- if (si.substring(start + j, start + j + 1).equals(
- sj.substring(start + j, start + j + 1)))
+ if (si.substring(start + j, start + j + 1)
+ .equals(sj.substring(start + j, start + j + 1)))
{
match++;
}
* @param s2
* SequenceI
* @return float
+ * @deprecated use PIDModel.computePID()
*/
+ @Deprecated
public final static float PID(String seq1, String seq2)
{
return PID(seq1, seq2, 0, seq1.length());
static final int caseShift = 'a' - 'A';
// Another pid with region specification
- public final static float PID(String seq1, String seq2, int start, int end)
+ /**
+ * @deprecated use PIDModel.computePID()
+ */
+ @Deprecated
+ public final static float PID(String seq1, String seq2, int start,
+ int end)
{
return PID(seq1, seq2, start, end, true, false);
}
* @param ungappedOnly
* - if true - only count PID over ungapped columns
* @return
+ * @deprecated use PIDModel.computePID()
*/
+ @Deprecated
public final static float PID(String seq1, String seq2, int start,
int end, boolean wcGaps, boolean ungappedOnly)
{
}
/**
+ * Overloaded method signature to test whether a single sequence is nucleotide
+ * (that is, more than 85% CGTAUNX)
+ *
+ * @param seq
+ * @return
+ */
+ public static final boolean isNucleotide(SequenceI seq)
+ {
+ if (seq == null)
+ {
+ return false;
+ }
+ long ntCount = 0;
+ long aaCount = 0;
+ long nCount = 0;
+
+ int len = seq.getLength();
+ for (int i = 0; i < len; i++)
+ {
+ char c = seq.getCharAt(i);
+ if (isNucleotide(c) || isX(c))
+ {
+ ntCount++;
+ }
+ else if (!isGap(c))
+ {
+ aaCount++;
+ if (isN(c))
+ {
+ nCount++;
+ }
+ }
+ }
+ /*
+ * Check for nucleotide count > 85% of total count (in a form that evades
+ * int / float conversion or divide by zero).
+ */
+ if ((ntCount + nCount) * 100 > EIGHTY_FIVE * (ntCount + aaCount))
+ {
+ return ntCount > 0; // all N is considered protein. Could use a threshold
+ // here too
+ }
+ else
+ {
+ return false;
+ }
+ }
+
+ /**
* Answers true if more than 85% of the sequence residues (ignoring gaps) are
* A, G, C, T or U, else false. This is just a heuristic guess and may give a
- * wrong answer (as AGCT are also animo acid codes).
+ * wrong answer (as AGCT are also amino acid codes).
*
* @param seqs
* @return
{
return false;
}
- int ntCount = 0;
- int aaCount = 0;
+ // true if we have seen a nucleotide sequence
+ boolean na = false;
for (SequenceI seq : seqs)
{
- for (char c : seq.getSequence())
+ if (seq == null)
{
- if ('a' <= c && c <= 'z')
- {
- c -= TO_UPPER_CASE;
- }
+ continue;
+ }
+ na = true;
+ // TODO could possibly make an informed guess just from the first sequence
+ // to save a lengthy calculation
+ if (seq.isProtein())
+ {
+ // if even one looks like protein, the alignment is protein
+ return false;
+ }
+ }
+ return na;
+ }
- if (c == 'A' || c == 'G' || c == 'C' || c == 'T' || c == 'U')
- {
- ntCount++;
- }
- else if (!Comparison.isGap(c))
+ /**
+ * Answers true if the character is one of aAcCgGtTuU
+ *
+ * @param c
+ * @return
+ */
+ public static boolean isNucleotide(char c)
+ {
+ if ('a' <= c && c <= 'z')
+ {
+ c -= TO_UPPER_CASE;
+ }
+ switch (c)
+ {
+ case 'A':
+ case 'C':
+ case 'G':
+ case 'T':
+ case 'U':
+ return true;
+ }
+ return false;
+ }
+
+ public static boolean isN(char c)
+ {
+ switch (c)
+ {
+ case 'N':
+ case 'n':
+ return true;
+ }
+ return false;
+ }
+
+ public static boolean isX(char c)
+ {
+ switch (c)
+ {
+ case 'X':
+ case 'x':
+ return true;
+ }
+ return false;
+ }
+
+ /**
+ * Answers true if every character in the string is one of aAcCgGtTuU, or
+ * (optionally) a gap character (dot, dash, space), else false
+ *
+ * @param s
+ * @param allowGaps
+ * @return
+ */
+ public static boolean isNucleotideSequence(String s, boolean allowGaps)
+ {
+ if (s == null)
+ {
+ return false;
+ }
+ for (int i = 0; i < s.length(); i++)
+ {
+ char c = s.charAt(i);
+ if (!isNucleotide(c))
+ {
+ if (!allowGaps || !isGap(c))
{
- aaCount++;
+ return false;
}
}
}
+ return true;
+ }
- /*
- * Check for nucleotide count > 85% of total count (in a form that evades
- * int / float conversion or divide by zero).
- */
- if (ntCount * 100 > EIGHTY_FIVE * (ntCount + aaCount))
+ /**
+ * Convenience overload of isNucleotide
+ *
+ * @param seqs
+ * @return
+ */
+ public static boolean isNucleotide(SequenceI[][] seqs)
+ {
+ if (seqs == null)
{
- return true;
+ return false;
}
- else
+ List<SequenceI> flattened = new ArrayList<SequenceI>();
+ for (SequenceI[] ss : seqs)
{
- return false;
+ for (SequenceI s : ss)
+ {
+ flattened.add(s);
+ }
}
+ final SequenceI[] oneDArray = flattened
+ .toArray(new SequenceI[flattened.size()]);
+ return isNucleotide(oneDArray);
+ }
+ /**
+ * Compares two residues either case sensitively or case insensitively
+ * depending on the caseSensitive flag
+ *
+ * @param c1
+ * first char
+ * @param c2
+ * second char to compare with
+ * @param caseSensitive
+ * if true comparison will be case sensitive otherwise its not
+ * @return
+ */
+ public static boolean isSameResidue(char c1, char c2,
+ boolean caseSensitive)
+ {
+ if (caseSensitive)
+ {
+ return (c1 == c2);
+ }
+ else
+ {
+ return Character.toUpperCase(c1) == Character.toUpperCase(c2);
+ }
}
}