JAL-3313 don't double count mapped codons
[jalview.git] / 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.awt.Color;
41 import java.util.Arrays;
42 import java.util.Hashtable;
43 import java.util.List;
44
45 /**
46  * Takes in a vector or array of sequences and column start and column end and
47  * returns a new Hashtable[] of size maxSeqLength, if Hashtable not supplied.
48  * This class is used extensively in calculating alignment colourschemes that
49  * depend on the amount of conservation in each alignment column.
50  * 
51  * @author $author$
52  * @version $Revision$
53  */
54 public class AAFrequency
55 {
56   public static final String PROFILE = "P";
57
58   /*
59    * Quick look-up of String value of char 'A' to 'Z'
60    */
61   private static final String[] CHARS = new String['Z' - 'A' + 1];
62
63   static
64   {
65     for (char c = 'A'; c <= 'Z'; c++)
66     {
67       CHARS[c - 'A'] = String.valueOf(c);
68     }
69   }
70
71   public static final ProfilesI calculate(List<SequenceI> list, int start,
72           int end)
73   {
74     return calculate(list, start, end, false);
75   }
76
77   public static final ProfilesI calculate(List<SequenceI> sequences,
78           int start, int end, boolean profile)
79   {
80     SequenceI[] seqs = new SequenceI[sequences.size()];
81     int width = 0;
82     synchronized (sequences)
83     {
84       for (int i = 0; i < sequences.size(); i++)
85       {
86         seqs[i] = sequences.get(i);
87         int length = seqs[i].getLength();
88         if (length > width)
89         {
90           width = length;
91         }
92       }
93
94       if (end >= width)
95       {
96         end = width;
97       }
98
99       ProfilesI reply = calculate(seqs, width, start, end, profile);
100       return reply;
101     }
102   }
103
104   /**
105    * Calculate the consensus symbol(s) for each column in the given range.
106    * 
107    * @param sequences
108    * @param width
109    *          the full width of the alignment
110    * @param start
111    *          start column (inclusive, base zero)
112    * @param end
113    *          end column (exclusive)
114    * @param saveFullProfile
115    *          if true, store all symbol counts
116    */
117   public static final ProfilesI calculate(final SequenceI[] sequences,
118           int width, int start, int end, boolean saveFullProfile)
119   {
120     // long now = System.currentTimeMillis();
121     int seqCount = sequences.length;
122     boolean nucleotide = false;
123     int nucleotideCount = 0;
124     int peptideCount = 0;
125
126     ProfileI[] result = new ProfileI[width];
127
128     for (int column = start; column < end; column++)
129     {
130       /*
131        * Apply a heuristic to detect nucleotide data (which can
132        * be counted in more compact arrays); here we test for
133        * more than 90% nucleotide; recheck every 10 columns in case
134        * of misleading data e.g. highly conserved Alanine in peptide!
135        * Mistakenly guessing nucleotide has a small performance cost,
136        * as it will result in counting in sparse arrays.
137        * Mistakenly guessing peptide has a small space cost, 
138        * as it will use a larger than necessary array to hold counts. 
139        */
140       if (nucleotideCount > 100 && column % 10 == 0)
141       {
142         nucleotide = (9 * peptideCount < nucleotideCount);
143       }
144       ResidueCount residueCounts = new ResidueCount(nucleotide);
145
146       for (int row = 0; row < seqCount; row++)
147       {
148         if (sequences[row] == null)
149         {
150           System.err.println(
151                   "WARNING: Consensus skipping null sequence - possible race condition.");
152           continue;
153         }
154         if (sequences[row].getLength() > column)
155         {
156           char c = sequences[row].getCharAt(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 gaprow
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 gaprow,
304           ProfilesI profiles, int startCol, int endCol, long nseq)
305   {
306     if (gaprow == null || gaprow.annotations == null
307             || gaprow.annotations.length < endCol)
308     {
309       /*
310        * called with a bad alignment annotation row 
311        * wait for it to be initialised properly
312        */
313       return;
314     }
315     // always set ranges again
316     gaprow.graphMax = nseq;
317     gaprow.graphMin = 0;
318     double scale = 0.8 / nseq;
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         gaprow.annotations[i] = null;
329         return;
330       }
331
332       final int gapped = profile.getNonGapped();
333
334       String description = "" + gapped;
335
336       gaprow.annotations[i] = new Annotation("", description, '\0', gapped,
337               jalview.util.ColorUtils.bleachColour(Color.DARK_GRAY,
338                       (float) scale * gapped));
339     }
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
348    * false</li>
349    * </ul>
350    * Percentages are as a fraction of all sequence, or only ungapped sequences
351    * if ignoreGaps is true.
352    * 
353    * @param profile
354    * @param pid
355    * @param showSequenceLogo
356    * @param ignoreGaps
357    * @param dp
358    *          the number of decimal places to format percentages to
359    * @return
360    */
361   static String getTooltip(ProfileI profile, float pid,
362           boolean showSequenceLogo, boolean ignoreGaps, int dp)
363   {
364     ResidueCount counts = profile.getCounts();
365
366     String description = null;
367     if (counts != null && showSequenceLogo)
368     {
369       int normaliseBy = ignoreGaps ? profile.getNonGapped()
370               : profile.getHeight();
371       description = counts.getTooltip(normaliseBy, dp);
372     }
373     else
374     {
375       StringBuilder sb = new StringBuilder(64);
376       String maxRes = profile.getModalResidue();
377       if (maxRes.length() > 1)
378       {
379         sb.append("[").append(maxRes).append("]");
380       }
381       else
382       {
383         sb.append(maxRes);
384       }
385       if (maxRes.length() > 0)
386       {
387         sb.append(" ");
388         Format.appendPercentage(sb, pid, dp);
389         sb.append("%");
390       }
391       description = sb.toString();
392     }
393     return description;
394   }
395
396   /**
397    * Returns the sorted profile for the given consensus data. The returned array
398    * contains
399    * 
400    * <pre>
401    *    [profileType, numberOfValues, nonGapCount, charValue1, percentage1, charValue2, percentage2, ...]
402    * in descending order of percentage value
403    * </pre>
404    * 
405    * @param profile
406    *          the data object from which to extract and sort values
407    * @param ignoreGaps
408    *          if true, only non-gapped values are included in percentage
409    *          calculations
410    * @return
411    */
412   public static int[] extractProfile(ProfileI profile, 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()
428             : profile.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<>();
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.findCodonsFor(seq, col,
546                 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             break;
555           }
556         }
557       }
558       codonCounts[1] = ungappedCount;
559       // todo: sort values here, save counts and codons?
560       columnHash.put(PROFILE, codonCounts);
561       hconsensus[col] = columnHash;
562     }
563   }
564
565   /**
566    * Derive displayable cDNA consensus annotation from computed consensus data.
567    * 
568    * @param consensusAnnotation
569    *          the annotation row to be populated for display
570    * @param consensusData
571    *          the computed consensus data
572    * @param showProfileLogo
573    *          if true show all symbols present at each position, else only the
574    *          modal value
575    * @param nseqs
576    *          the number of sequences in the alignment
577    */
578   public static void completeCdnaConsensus(
579           AlignmentAnnotation consensusAnnotation,
580           Hashtable[] consensusData, boolean showProfileLogo, int nseqs)
581   {
582     if (consensusAnnotation == null
583             || consensusAnnotation.annotations == null
584             || consensusAnnotation.annotations.length < consensusData.length)
585     {
586       // called with a bad alignment annotation row - wait for it to be
587       // initialised properly
588       return;
589     }
590
591     // ensure codon triplet scales with font size
592     consensusAnnotation.scaleColLabel = true;
593     for (int col = 0; col < consensusData.length; col++)
594     {
595       Hashtable hci = consensusData[col];
596       if (hci == null)
597       {
598         // gapped protein column?
599         continue;
600       }
601       // array holds #seqs, #ungapped, then codon counts indexed by codon
602       final int[] codonCounts = (int[]) hci.get(PROFILE);
603       int totalCount = 0;
604
605       /*
606        * First pass - get total count and find the highest
607        */
608       final char[] codons = new char[codonCounts.length - 2];
609       for (int j = 2; j < codonCounts.length; j++)
610       {
611         final int codonCount = codonCounts[j];
612         codons[j - 2] = (char) (j - 2);
613         totalCount += codonCount;
614       }
615
616       /*
617        * Sort array of encoded codons by count ascending - so the modal value
618        * goes to the end; start by copying the count (dropping the first value)
619        */
620       int[] sortedCodonCounts = new int[codonCounts.length - 2];
621       System.arraycopy(codonCounts, 2, sortedCodonCounts, 0,
622               codonCounts.length - 2);
623       QuickSort.sort(sortedCodonCounts, codons);
624
625       int modalCodonEncoded = codons[codons.length - 1];
626       int modalCodonCount = sortedCodonCounts[codons.length - 1];
627       String modalCodon = String
628               .valueOf(CodingUtils.decodeCodon(modalCodonEncoded));
629       if (sortedCodonCounts.length > 1 && sortedCodonCounts[codons.length
630               - 2] == sortedCodonCounts[codons.length - 1])
631       {
632         /*
633          * two or more codons share the modal count
634          */
635         modalCodon = "+";
636       }
637       float pid = sortedCodonCounts[sortedCodonCounts.length - 1] * 100
638               / (float) totalCount;
639
640       /*
641        * todo ? Replace consensus hashtable with sorted arrays of codons and
642        * counts (non-zero only). Include total count in count array [0].
643        */
644
645       /*
646        * Scan sorted array backwards for most frequent values first. Show
647        * repeated values compactly.
648        */
649       StringBuilder mouseOver = new StringBuilder(32);
650       StringBuilder samePercent = new StringBuilder();
651       String percent = null;
652       String lastPercent = null;
653       int percentDecPl = getPercentageDp(nseqs);
654
655       for (int j = codons.length - 1; j >= 0; j--)
656       {
657         int codonCount = sortedCodonCounts[j];
658         if (codonCount == 0)
659         {
660           /*
661            * remaining codons are 0% - ignore, but finish off the last one if
662            * necessary
663            */
664           if (samePercent.length() > 0)
665           {
666             mouseOver.append(samePercent).append(": ").append(percent)
667                     .append("% ");
668           }
669           break;
670         }
671         int codonEncoded = codons[j];
672         final int pct = codonCount * 100 / totalCount;
673         String codon = String
674                 .valueOf(CodingUtils.decodeCodon(codonEncoded));
675         StringBuilder sb = new StringBuilder();
676         Format.appendPercentage(sb, pct, percentDecPl);
677         percent = sb.toString();
678         if (showProfileLogo || codonCount == modalCodonCount)
679         {
680           if (percent.equals(lastPercent) && j > 0)
681           {
682             samePercent.append(samePercent.length() == 0 ? "" : ", ");
683             samePercent.append(codon);
684           }
685           else
686           {
687             if (samePercent.length() > 0)
688             {
689               mouseOver.append(samePercent).append(": ").append(lastPercent)
690                       .append("% ");
691             }
692             samePercent.setLength(0);
693             samePercent.append(codon);
694           }
695           lastPercent = percent;
696         }
697       }
698
699       consensusAnnotation.annotations[col] = new Annotation(modalCodon,
700               mouseOver.toString(), ' ', pid);
701     }
702   }
703
704   /**
705    * Returns the number of decimal places to show for profile percentages. For
706    * less than 100 sequences, returns zero (the integer percentage value will be
707    * displayed). For 100-999 sequences, returns 1, for 1000-9999 returns 2, etc.
708    * 
709    * @param nseq
710    * @return
711    */
712   protected static int getPercentageDp(long nseq)
713   {
714     int scale = 0;
715     while (nseq >= 100)
716     {
717       scale++;
718       nseq /= 10;
719     }
720     return scale;
721   }
722 }