src/jalview/analysis/AAFrequency.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.analysis;
  22
  23 import jalview.datamodel.AlignedCodonFrame;
  24 import jalview.datamodel.AlignmentAnnotation;
  25 import jalview.datamodel.AlignmentI;
  26 import jalview.datamodel.Annotation;
  27 import jalview.datamodel.Profile;
  28 import jalview.datamodel.ProfileI;
  29 import jalview.datamodel.Profiles;
  30 import jalview.datamodel.ProfilesI;
  31 import jalview.datamodel.ResidueCount;
  32 import jalview.datamodel.ResidueCount.SymbolCounts;
  33 import jalview.datamodel.SequenceI;
  34 import jalview.ext.android.SparseIntArray;
  35 import jalview.util.Comparison;
  36 import jalview.util.Format;
  37 import jalview.util.MappingUtils;
  38 import jalview.util.QuickSort;
  39
  40 import java.util.Arrays;
  41 import java.util.Hashtable;
  42 import java.util.List;
  43
  44 /**
  45  * Takes in a vector or array of sequences and column start and column end and
  46  * returns a new Hashtable[] of size maxSeqLength, if Hashtable not supplied.
  47  * This class is used extensively in calculating alignment colourschemes that
  48  * depend on the amount of conservation in each alignment column.
  49  *
  50  * @author $author$
  51  * @version $Revision$
  52  */
  53 public class AAFrequency
  54 {
  55   public static final String PROFILE = "P";
  56
  57   /*
  58    * Quick look-up of String value of char 'A' to 'Z'
  59    */
  60   private static final String[] CHARS = new String['Z' - 'A' + 1];
  61
  62   static
  63   {
  64     for (char c = 'A'; c <= 'Z'; c++)
  65     {
  66       CHARS[c - 'A'] = String.valueOf(c);
  67     }
  68   }
  69
  70   public static final ProfilesI calculate(List<SequenceI> list,
  71           int start, int end)
  72   {
  73     return calculate(list, start, end, false);
  74   }
  75
  76   public static final ProfilesI calculate(List<SequenceI> sequences,
  77           int start, int end, boolean profile)
  78   {
  79     SequenceI[] seqs = new SequenceI[sequences.size()];
  80     int width = 0;
  81     synchronized (sequences)
  82     {
  83       for (int i = 0; i < sequences.size(); i++)
  84       {
  85         seqs[i] = sequences.get(i);
  86         int length = seqs[i].getLength();
  87         if (length > width)
  88         {
  89           width = length;
  90         }
  91       }
  92
  93       if (end >= width)
  94       {
  95         end = width;
  96       }
  97
  98       ProfilesI reply = calculate(seqs, width, start, end, profile);
  99       return reply;
 100     }
 101   }
 102
 103   /**
 104    * Calculate the consensus symbol(s) for each column in the given range.
 105    *
 106    * @param sequences
 107    * @param width
 108    *          the full width of the alignment
 109    * @param start
 110    *          start column (inclusive, base zero)
 111    * @param end
 112    *          end column (exclusive)
 113    * @param saveFullProfile
 114    *          if true, store all symbol counts
 115    */
 116   public static final ProfilesI calculate(final SequenceI[] sequences,
 117           int width, int start, int end, boolean saveFullProfile)
 118   {
 119     // long now = System.currentTimeMillis();
 120     int seqCount = sequences.length;
 121     boolean nucleotide = false;
 122     int nucleotideCount = 0;
 123     int peptideCount = 0;
 124
 125     ProfileI[] result = new ProfileI[width];
 126
 127     for (int column = start; column < end; column++)
 128     {
 129       /*
 130        * Apply a heuristic to detect nucleotide data (which can
 131        * be counted in more compact arrays); here we test for
 132        * more than 90% nucleotide; recheck every 10 columns in case
 133        * of misleading data e.g. highly conserved Alanine in peptide!
 134        * Mistakenly guessing nucleotide has a small performance cost,
 135        * as it will result in counting in sparse arrays.
 136        * Mistakenly guessing peptide has a small space cost,
 137        * as it will use a larger than necessary array to hold counts.
 138        */
 139       if (nucleotideCount > 100 && column % 10 == 0)
 140       {
 141         nucleotide = (9 * peptideCount < nucleotideCount);
 142       }
 143       ResidueCount residueCounts = new ResidueCount(nucleotide);
 144
 145       for (int row = 0; row < seqCount; row++)
 146       {
 147         if (sequences[row] == null)
 148         {
 149           System.err
 150                   .println("WARNING: Consensus skipping null sequence - possible race condition.");
 151           continue;
 152         }
 153         char[] seq = sequences[row].getSequence();
 154         if (seq.length > column)
 155         {
 156           char c = seq[column];
 157           residueCounts.add(c);
 158           if (Comparison.isNucleotide(c))
 159           {
 160             nucleotideCount++;
 161           }
 162           else if (!Comparison.isGap(c))
 163           {
 164             peptideCount++;
 165           }
 166         }
 167         else
 168         {
 169           /*
 170            * count a gap if the sequence doesn't reach this column
 171            */
 172           residueCounts.addGap();
 173         }
 174       }
 175
 176       int maxCount = residueCounts.getModalCount();
 177       String maxResidue = residueCounts.getResiduesForCount(maxCount);
 178       int gapCount = residueCounts.getGapCount();
 179       ProfileI profile = new Profile(seqCount, gapCount, maxCount,
 180               maxResidue);
 181
 182       if (saveFullProfile)
 183       {
 184         profile.setCounts(residueCounts);
 185       }
 186
 187       result[column] = profile;
 188     }
 189     return new Profiles(result);
 190     // long elapsed = System.currentTimeMillis() - now;
 191     // System.out.println(elapsed);
 192   }
 193
 194   /**
 195    * Make an estimate of the profile size we are going to compute i.e. how many
 196    * different characters may be present in it. Overestimating has a cost of
 197    * using more memory than necessary. Underestimating has a cost of needing to
 198    * extend the SparseIntArray holding the profile counts.
 199    *
 200    * @param profileSizes
 201    *          counts of sizes of profiles so far encountered
 202    * @return
 203    */
 204   static int estimateProfileSize(SparseIntArray profileSizes)
 205   {
 206     if (profileSizes.size() == 0)
 207     {
 208       return 4;
 209     }
 210
 211     /*
 212      * could do a statistical heuristic here e.g. 75%ile
 213      * for now just return the largest value
 214      */
 215     return profileSizes.keyAt(profileSizes.size() - 1);
 216   }
 217
 218   /**
 219    * Derive the consensus annotations to be added to the alignment for display.
 220    * This does not recompute the raw data, but may be called on a change in
 221    * display options, such as 'ignore gaps', which may in turn result in a
 222    * change in the derived values.
 223    *
 224    * @param consensus
 225    *          the annotation row to add annotations to
 226    * @param profiles
 227    *          the source consensus data
 228    * @param startCol
 229    *          start column (inclusive)
 230    * @param endCol
 231    *          end column (exclusive)
 232    * @param ignoreGaps
 233    *          if true, normalise residue percentages ignoring gaps
 234    * @param showSequenceLogo
 235    *          if true include all consensus symbols, else just show modal
 236    *          residue
 237    * @param nseq
 238    *          number of sequences
 239    */
 240   public static void completeConsensus(AlignmentAnnotation consensus,
 241           ProfilesI profiles, int startCol, int endCol, boolean ignoreGaps,
 242           boolean showSequenceLogo, long nseq)
 243   {
 244     // long now = System.currentTimeMillis();
 245     if (consensus == null || consensus.annotations == null
 246             || consensus.annotations.length < endCol)
 247     {
 248       /*
 249        * called with a bad alignment annotation row
 250        * wait for it to be initialised properly
 251        */
 252       return;
 253     }
 254
 255     for (int i = startCol; i < endCol; i++)
 256     {
 257       ProfileI profile = profiles.get(i);
 258       if (profile == null)
 259       {
 260         /*
 261          * happens if sequences calculated over were
 262          * shorter than alignment width
 263          */
 264         consensus.annotations[i] = null;
 265         return;
 266       }
 267
 268       final int dp = getPercentageDp(nseq);
 269
 270       float value = profile.getPercentageIdentity(ignoreGaps);
 271
 272       String description = getTooltip(profile, value, showSequenceLogo,
 273               ignoreGaps, dp);
 274
 275       String modalResidue = profile.getModalResidue();
 276       if ("".equals(modalResidue))
 277       {
 278         modalResidue = "-";
 279       }
 280       else if (modalResidue.length() > 1)
 281       {
 282         modalResidue = "+";
 283       }
 284       consensus.annotations[i] = new Annotation(modalResidue, description,
 285               ' ', value);
 286     }
 287     // long elapsed = System.currentTimeMillis() - now;
 288     // System.out.println(-elapsed);
 289   }
 290
 291   /**
 292    * Derive the gap count annotation row.
 293    *
 294    * @param consensus
 295    *          the annotation row to add annotations to
 296    * @param profiles
 297    *          the source consensus data
 298    * @param startCol
 299    *          start column (inclusive)
 300    * @param endCol
 301    *          end column (exclusive)
 302    */
 303   public static void completeGapAnnot(AlignmentAnnotation consensus,
 304           ProfilesI profiles, int startCol, int endCol, long nseq)
 305   {
 306     // long now = System.currentTimeMillis();
 307     if (consensus == null || consensus.annotations == null
 308             || consensus.annotations.length < endCol)
 309     {
 310       /*
 311        * called with a bad alignment annotation row
 312        * wait for it to be initialised properly
 313        */
 314       return;
 315     }
 316     // always set ranges again
 317     consensus.graphMax = nseq;
 318     consensus.graphMin = 0;
 319     for (int i = startCol; i < endCol; i++)
 320     {
 321       ProfileI profile = profiles.get(i);
 322       if (profile == null)
 323       {
 324         /*
 325          * happens if sequences calculated over were
 326          * shorter than alignment width
 327          */
 328         consensus.annotations[i] = null;
 329         return;
 330       }
 331
 332       final int gapped = profile.getGapped();
 333
 334       String description = "" + gapped;
 335
 336       consensus.annotations[i] = new Annotation(gapped);
 337     }
 338     // long elapsed = System.currentTimeMillis() - now;
 339     // System.out.println(-elapsed);
 340   }
 341
 342   /**
 343    * Returns a tooltip showing either
 344    * <ul>
 345    * <li>the full profile (percentages of all residues present), if
 346    * showSequenceLogo is true, or</li>
 347    * <li>just the modal (most common) residue(s), if showSequenceLogo is false</li>
 348    * </ul>
 349    * Percentages are as a fraction of all sequence, or only ungapped sequences
 350    * if ignoreGaps is true.
 351    *
 352    * @param profile
 353    * @param pid
 354    * @param showSequenceLogo
 355    * @param ignoreGaps
 356    * @param dp
 357    *          the number of decimal places to format percentages to
 358    * @return
 359    */
 360   static String getTooltip(ProfileI profile, float pid,
 361           boolean showSequenceLogo, boolean ignoreGaps, int dp)
 362   {
 363     ResidueCount counts = profile.getCounts();
 364
 365     String description = null;
 366     if (counts != null && showSequenceLogo)
 367     {
 368       int normaliseBy = ignoreGaps ? profile.getNonGapped() : profile
 369               .getHeight();
 370       description = counts.getTooltip(normaliseBy, dp);
 371     }
 372     else
 373     {
 374       StringBuilder sb = new StringBuilder(64);
 375       String maxRes = profile.getModalResidue();
 376       if (maxRes.length() > 1)
 377       {
 378         sb.append("[").append(maxRes).append("]");
 379       }
 380       else
 381       {
 382         sb.append(maxRes);
 383       }
 384       if (maxRes.length() > 0)
 385       {
 386         sb.append(" ");
 387         Format.appendPercentage(sb, pid, dp);
 388         sb.append("%");
 389       }
 390       description = sb.toString();
 391     }
 392     return description;
 393   }
 394
 395   /**
 396    * Returns the sorted profile for the given consensus data. The returned array
 397    * contains
 398    *
 399    * <pre>
 400    *    [profileType, numberOfValues, nonGapCount, charValue1, percentage1, charValue2, percentage2, ...]
 401    * in descending order of percentage value
 402    * </pre>
 403    *
 404    * @param profile
 405    *          the data object from which to extract and sort values
 406    * @param ignoreGaps
 407    *          if true, only non-gapped values are included in percentage
 408    *          calculations
 409    * @return
 410    */
 411   public static int[] extractProfile(ProfileI profile,
 412           boolean ignoreGaps)
 413   {
 414     int[] rtnval = new int[64];
 415     ResidueCount counts = profile.getCounts();
 416     if (counts == null)
 417     {
 418       return null;
 419     }
 420
 421     SymbolCounts symbolCounts = counts.getSymbolCounts();
 422     char[] symbols = symbolCounts.symbols;
 423     int[] values = symbolCounts.values;
 424     QuickSort.sort(values, symbols);
 425     int nextArrayPos = 2;
 426     int totalPercentage = 0;
 427     final int divisor = ignoreGaps ? profile.getNonGapped() : profile
 428             .getHeight();
 429
 430     /*
 431      * traverse the arrays in reverse order (highest counts first)
 432      */
 433     for (int i = symbols.length - 1; i >= 0; i--)
 434     {
 435       int theChar = symbols[i];
 436       int charCount = values[i];
 437
 438       rtnval[nextArrayPos++] = theChar;
 439       final int percentage = (charCount * 100) / divisor;
 440       rtnval[nextArrayPos++] = percentage;
 441       totalPercentage += percentage;
 442     }
 443     rtnval[0] = symbols.length;
 444     rtnval[1] = totalPercentage;
 445     int[] result = new int[rtnval.length + 1];
 446     result[0] = AlignmentAnnotation.SEQUENCE_PROFILE;
 447     System.arraycopy(rtnval, 0, result, 1, rtnval.length);
 448
 449     return result;
 450   }
 451
 452   /**
 453    * Extract a sorted extract of cDNA codon profile data. The returned array
 454    * contains
 455    *
 456    * <pre>
 457    *    [profileType, numberOfValues, totalCount, charValue1, percentage1, charValue2, percentage2, ...]
 458    * in descending order of percentage value, where the character values encode codon triplets
 459    * </pre>
 460    *
 461    * @param hashtable
 462    * @return
 463    */
 464   public static int[] extractCdnaProfile(Hashtable hashtable,
 465           boolean ignoreGaps)
 466   {
 467     // this holds #seqs, #ungapped, and then codon count, indexed by encoded
 468     // codon triplet
 469     int[] codonCounts = (int[]) hashtable.get(PROFILE);
 470     int[] sortedCounts = new int[codonCounts.length - 2];
 471     System.arraycopy(codonCounts, 2, sortedCounts, 0,
 472             codonCounts.length - 2);
 473
 474     int[] result = new int[3 + 2 * sortedCounts.length];
 475     // first value is just the type of profile data
 476     result[0] = AlignmentAnnotation.CDNA_PROFILE;
 477
 478     char[] codons = new char[sortedCounts.length];
 479     for (int i = 0; i < codons.length; i++)
 480     {
 481       codons[i] = (char) i;
 482     }
 483     QuickSort.sort(sortedCounts, codons);
 484     int totalPercentage = 0;
 485     int distinctValuesCount = 0;
 486     int j = 3;
 487     int divisor = ignoreGaps ? codonCounts[1] : codonCounts[0];
 488     for (int i = codons.length - 1; i >= 0; i--)
 489     {
 490       final int codonCount = sortedCounts[i];
 491       if (codonCount == 0)
 492       {
 493         break; // nothing else of interest here
 494       }
 495       distinctValuesCount++;
 496       result[j++] = codons[i];
 497       final int percentage = codonCount * 100 / divisor;
 498       result[j++] = percentage;
 499       totalPercentage += percentage;
 500     }
 501     result[2] = totalPercentage;
 502
 503     /*
 504      * Just return the non-zero values
 505      */
 506     // todo next value is redundant if we limit the array to non-zero counts
 507     result[1] = distinctValuesCount;
 508     return Arrays.copyOfRange(result, 0, j);
 509   }
 510
 511   /**
 512    * Compute a consensus for the cDNA coding for a protein alignment.
 513    *
 514    * @param alignment
 515    *          the protein alignment (which should hold mappings to cDNA
 516    *          sequences)
 517    * @param hconsensus
 518    *          the consensus data stores to be populated (one per column)
 519    */
 520   public static void calculateCdna(AlignmentI alignment,
 521           Hashtable[] hconsensus)
 522   {
 523     final char gapCharacter = alignment.getGapCharacter();
 524     List<AlignedCodonFrame> mappings = alignment.getCodonFrames();
 525     if (mappings == null || mappings.isEmpty())
 526     {
 527       return;
 528     }
 529
 530     int cols = alignment.getWidth();
 531     for (int col = 0; col < cols; col++)
 532     {
 533       // todo would prefer a Java bean for consensus data
 534       Hashtable<String, int[]> columnHash = new Hashtable<String, int[]>();
 535       // #seqs, #ungapped seqs, counts indexed by (codon encoded + 1)
 536       int[] codonCounts = new int[66];
 537       codonCounts[0] = alignment.getSequences().size();
 538       int ungappedCount = 0;
 539       for (SequenceI seq : alignment.getSequences())
 540       {
 541         if (seq.getCharAt(col) == gapCharacter)
 542         {
 543           continue;
 544         }
 545         List<char[]> codons = MappingUtils
 546                 .findCodonsFor(seq, col, mappings);
 547         for (char[] codon : codons)
 548         {
 549           int codonEncoded = CodingUtils.encodeCodon(codon);
 550           if (codonEncoded >= 0)
 551           {
 552             codonCounts[codonEncoded + 2]++;
 553             ungappedCount++;
 554           }
 555         }
 556       }
 557       codonCounts[1] = ungappedCount;
 558       // todo: sort values here, save counts and codons?
 559       columnHash.put(PROFILE, codonCounts);
 560       hconsensus[col] = columnHash;
 561     }
 562   }
 563
 564   /**
 565    * Derive displayable cDNA consensus annotation from computed consensus data.
 566    *
 567    * @param consensusAnnotation
 568    *          the annotation row to be populated for display
 569    * @param consensusData
 570    *          the computed consensus data
 571    * @param showProfileLogo
 572    *          if true show all symbols present at each position, else only the
 573    *          modal value
 574    * @param nseqs
 575    *          the number of sequences in the alignment
 576    */
 577   public static void completeCdnaConsensus(
 578           AlignmentAnnotation consensusAnnotation,
 579           Hashtable[] consensusData, boolean showProfileLogo, int nseqs)
 580   {
 581     if (consensusAnnotation == null
 582             || consensusAnnotation.annotations == null
 583             || consensusAnnotation.annotations.length < consensusData.length)
 584     {
 585       // called with a bad alignment annotation row - wait for it to be
 586       // initialised properly
 587       return;
 588     }
 589
 590     // ensure codon triplet scales with font size
 591     consensusAnnotation.scaleColLabel = true;
 592     for (int col = 0; col < consensusData.length; col++)
 593     {
 594       Hashtable hci = consensusData[col];
 595       if (hci == null)
 596       {
 597         // gapped protein column?
 598         continue;
 599       }
 600       // array holds #seqs, #ungapped, then codon counts indexed by codon
 601       final int[] codonCounts = (int[]) hci.get(PROFILE);
 602       int totalCount = 0;
 603
 604       /*
 605        * First pass - get total count and find the highest
 606        */
 607       final char[] codons = new char[codonCounts.length - 2];
 608       for (int j = 2; j < codonCounts.length; j++)
 609       {
 610         final int codonCount = codonCounts[j];
 611         codons[j - 2] = (char) (j - 2);
 612         totalCount += codonCount;
 613       }
 614
 615       /*
 616        * Sort array of encoded codons by count ascending - so the modal value
 617        * goes to the end; start by copying the count (dropping the first value)
 618        */
 619       int[] sortedCodonCounts = new int[codonCounts.length - 2];
 620       System.arraycopy(codonCounts, 2, sortedCodonCounts, 0,
 621               codonCounts.length - 2);
 622       QuickSort.sort(sortedCodonCounts, codons);
 623
 624       int modalCodonEncoded = codons[codons.length - 1];
 625       int modalCodonCount = sortedCodonCounts[codons.length - 1];
 626       String modalCodon = String.valueOf(CodingUtils
 627               .decodeCodon(modalCodonEncoded));
 628       if (sortedCodonCounts.length > 1
 629               && sortedCodonCounts[codons.length - 2] == sortedCodonCounts[codons.length - 1])
 630       {
 631         /*
 632          * two or more codons share the modal count
 633          */
 634         modalCodon = "+";
 635       }
 636       float pid = sortedCodonCounts[sortedCodonCounts.length - 1] * 100
 637               / (float) totalCount;
 638
 639       /*
 640        * todo ? Replace consensus hashtable with sorted arrays of codons and
 641        * counts (non-zero only). Include total count in count array [0].
 642        */
 643
 644       /*
 645        * Scan sorted array backwards for most frequent values first. Show
 646        * repeated values compactly.
 647        */
 648       StringBuilder mouseOver = new StringBuilder(32);
 649       StringBuilder samePercent = new StringBuilder();
 650       String percent = null;
 651       String lastPercent = null;
 652       int percentDecPl = getPercentageDp(nseqs);
 653
 654       for (int j = codons.length - 1; j >= 0; j--)
 655       {
 656         int codonCount = sortedCodonCounts[j];
 657         if (codonCount == 0)
 658         {
 659           /*
 660            * remaining codons are 0% - ignore, but finish off the last one if
 661            * necessary
 662            */
 663           if (samePercent.length() > 0)
 664           {
 665             mouseOver.append(samePercent).append(": ").append(percent)
 666                     .append("% ");
 667           }
 668           break;
 669         }
 670         int codonEncoded = codons[j];
 671         final int pct = codonCount * 100 / totalCount;
 672         String codon = String
 673                 .valueOf(CodingUtils.decodeCodon(codonEncoded));
 674         StringBuilder sb = new StringBuilder();
 675         Format.appendPercentage(sb, pct, percentDecPl);
 676         percent = sb.toString();
 677         if (showProfileLogo || codonCount == modalCodonCount)
 678         {
 679           if (percent.equals(lastPercent) && j > 0)
 680           {
 681             samePercent.append(samePercent.length() == 0 ? "" : ", ");
 682             samePercent.append(codon);
 683           }
 684           else
 685           {
 686             if (samePercent.length() > 0)
 687             {
 688               mouseOver.append(samePercent).append(": ")
 689                       .append(lastPercent).append("% ");
 690             }
 691             samePercent.setLength(0);
 692             samePercent.append(codon);
 693           }
 694           lastPercent = percent;
 695         }
 696       }
 697
 698       consensusAnnotation.annotations[col] = new Annotation(modalCodon,
 699               mouseOver.toString(), ' ', pid);
 700     }
 701   }
 702
 703   /**
 704    * Returns the number of decimal places to show for profile percentages. For
 705    * less than 100 sequences, returns zero (the integer percentage value will be
 706    * displayed). For 100-999 sequences, returns 1, for 1000-9999 returns 2, etc.
 707    *
 708    * @param nseq
 709    * @return
 710    */
 711   protected static int getPercentageDp(long nseq)
 712   {
 713     int scale = 0;
 714     while (nseq >= 100)
 715     {
 716       scale++;
 717       nseq /= 10;
 718     }
 719     return scale;
 720   }
 721 }