src/jalview/analysis/StructureFrequency.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)
   3  * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
   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 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18 package jalview.analysis;
  19
  20 import java.util.*;
  21
  22 import jalview.datamodel.*;
  23
  24 /**
  25  * Takes in a vector or array of sequences and column start and column end and
  26  * returns a new Hashtable[] of size maxSeqLength, if Hashtable not supplied.
  27  * This class is used extensively in calculating alignment colourschemes that
  28  * depend on the amount of conservation in each alignment column.
  29  *
  30  * @author $author$
  31  * @version $Revision$
  32  */
  33 public class StructureFrequency
  34 {
  35   // No need to store 1000s of strings which are not
  36   // visible to the user.
  37   public static final String MAXCOUNT = "C";
  38
  39   public static final String MAXRESIDUE = "R";
  40
  41   public static final String PID_GAPS = "G";
  42
  43   public static final String PID_NOGAPS = "N";
  44
  45   public static final String PROFILE = "P";
  46
  47   public static final Hashtable[] calculate(Vector sequences, int start,
  48           int end)
  49   {
  50     return calculate(sequences, start, end, false);
  51   }
  52
  53   public static final Hashtable[] calculate(Vector sequences, int start,
  54           int end, boolean profile)
  55   {
  56     SequenceI[] seqs = new SequenceI[sequences.size()];
  57     int width = 0;
  58     for (int i = 0; i < sequences.size(); i++)
  59     {
  60       seqs[i] = (SequenceI) sequences.elementAt(i);
  61       if (seqs[i].getLength() > width)
  62       {
  63         width = seqs[i].getLength();
  64       }
  65     }
  66
  67     Hashtable[] reply = new Hashtable[width];
  68
  69     if (end >= width)
  70     {
  71       end = width;
  72     }
  73
  74     calculate(seqs, start, end, reply, profile);
  75
  76     return reply;
  77   }
  78
  79   public static final void calculate(SequenceI[] sequences, int start,
  80           int end, Hashtable[] result)
  81   {
  82     calculate(sequences, start, end, result, false);
  83   }
  84
  85   public static final void calculate(SequenceI[] sequences, int start,
  86           int end, Hashtable[] result, boolean profile)
  87   {
  88     Hashtable residueHash;
  89     int maxCount, nongap, i, j, v, jSize = sequences.length;
  90     String maxResidue;
  91     char c;
  92     float percentage;
  93
  94     int[] values = new int[255];
  95
  96     char[] seq;
  97
  98     for (i = start; i < end; i++)
  99     {
 100       residueHash = new Hashtable();
 101       maxCount = 0;
 102       maxResidue = "";
 103       nongap = 0;
 104       values = new int[255];
 105
 106       for (j = 0; j < jSize; j++)
 107       {
 108         if (sequences[j]==null)
 109         {
 110           System.err.println("WARNING: Consensus skipping null sequence - possible race condition.");
 111           continue;
 112         }
 113         seq = sequences[j].getSequence();
 114         if (seq.length > i)
 115         {
 116           c = seq[i];
 117
 118           if (c == '.' || c == ' ')
 119           {
 120             c = '-';
 121           }
 122
 123           if (c == '-')
 124           {
 125             values['-']++;
 126             continue;
 127           }
 128           else if ('a' <= c && c <= 'z')
 129           {
 130             c -= 32; // ('a' - 'A');
 131           }
 132
 133           nongap++;
 134           values[c]++;
 135
 136         }
 137         else
 138         {
 139           values['-']++;
 140         }
 141       }
 142
 143       for (v = 'A'; v < 'Z'; v++)
 144       {
 145         if (values[v] < 2 || values[v] < maxCount)
 146         {
 147           continue;
 148         }
 149
 150         if (values[v] > maxCount)
 151         {
 152           maxResidue = String.valueOf((char) v);
 153         }
 154         else if (values[v] == maxCount)
 155         {
 156           maxResidue += String.valueOf((char) v);
 157         }
 158         maxCount = values[v];
 159       }
 160
 161       if (maxResidue.length() == 0)
 162       {
 163         maxResidue = "-";
 164       }
 165       if (profile)
 166       {
 167         residueHash.put(PROFILE, new int[][]
 168         { values, new int[]
 169         { jSize, nongap } });
 170       }
 171       residueHash.put(MAXCOUNT, new Integer(maxCount));
 172       residueHash.put(MAXRESIDUE, maxResidue);
 173
 174       percentage = ((float) maxCount * 100) / (float) jSize;
 175       residueHash.put(PID_GAPS, new Float(percentage));
 176
 177       percentage = ((float) maxCount * 100) / (float) nongap;
 178       residueHash.put(PID_NOGAPS, new Float(percentage));
 179       result[i] = residueHash;
 180     }
 181   }
 182
 183   /**
 184    * Method to calculate a 'base pair consensus row', very similar
 185    * to nucleotide consensus but takes into account a given structure
 186    * @param sequences
 187    * @param start
 188    * @param end
 189    * @param result
 190    * @param profile
 191    * @param rnaStruc
 192    */
 193   public static final void calculate(SequenceI[] sequences, int start,
 194           int end, Hashtable[] result, boolean profile, AlignmentAnnotation rnaStruc){
 195           //TODO Consider to use AlignmentAnnotation instead of structure string
 196
 197           Hashtable residueHash;
 198
 199           char[] seq, struc=rnaStruc.getRNAStruc().toCharArray();
 200           SequenceFeature[] rna =rnaStruc._rnasecstr;
 201           char c,s,cEnd;
 202           int count,nonGap,i,j,jSize = sequences.length;
 203           int[] values = new int[255];
 204           float percentage;
 205
 206
 207           for (i = start; i < end; i++) //foreach column
 208             {
 209               residueHash = new Hashtable();
 210               for (j = 0; j < jSize; j++) //foreach row
 211               {
 212                 if (sequences[j]==null)
 213                 {
 214                   System.err.println("WARNING: Consensus skipping null sequence - possible race condition.");
 215                   continue;
 216                 }
 217                 seq = sequences[j].getSequence();
 218                 if (seq.length > i)
 219                 {
 220                         c = seq[i];
 221                         s = struc[i];
 222                         nonGap=0;
 223
 224                         //standard representation for gaps in sequence and structure
 225                         if (c == '.' || c == ' ')
 226                     {
 227                       c = '-';
 228                     }
 229                         if (s == '.' || s == ' ')
 230                     {
 231                       s = '-';
 232                     }
 233
 234                         if (c == '-')
 235                     {
 236                       values['-']++;
 237                       continue;
 238                     }
 239                         if(s == '-'){
 240                                 values['-']++;
 241                                 continue;
 242                         }
 243                         nonGap++;
 244                         cEnd=seq[rna[i].getEnd()];
 245                         if(checkBpType(c,cEnd)){
 246                                 values['H']++; //H means it's a helix (structured)
 247                         }
 248                 }
 249               }
 250               /*UPDATE this for new values
 251               if (profile)
 252               {
 253                 residueHash.put(PROFILE, new int[][]
 254                 { values, new int[]
 255                 { jSize, nongap } });
 256               }
 257               */
 258
 259               count=values['H'];
 260
 261               percentage = ((float) count * 100) / (float) jSize;
 262               residueHash.put(PID_GAPS, new Float(percentage));
 263
 264               //percentage = ((float) count * 100) / (float) nongap;
 265               //residueHash.put(PID_NOGAPS, new Float(percentage));
 266               result[i] = residueHash;
 267
 268             }
 269   }
 270
 271
 272   /**
 273    * Method to check if a base-pair is a canonical or a wobble bp
 274    * @param up 5' base
 275    * @param down 3' base
 276    * @return True if it is a canonical/wobble bp
 277    */
 278   public static boolean checkBpType(char up, char down){
 279           if(up>'Z'){up-=32;}
 280           if(down>'Z'){down-=32;}
 281
 282           switch (up){
 283                 case 'A':
 284                         switch (down){
 285                                 case 'T': return true;
 286                                 case 'U': return true;
 287                         }
 288                 break;
 289                 case 'C':
 290                         switch (down){
 291                                 case 'G': return true;
 292                         }
 293                 break;
 294                 case 'T':
 295                         switch (down){
 296                                 case 'A': return true;
 297                                 case 'G': return true;
 298                                 }
 299                 break;
 300                 case 'G':
 301                         switch (down){
 302                                 case 'C': return true;
 303                                 case 'T': return true;
 304                                 case 'U': return true;
 305                         }
 306                 break;
 307                 case 'U':
 308                         switch (down){
 309                                 case 'A': return true;
 310                                 case 'G': return true;
 311                         }
 312                 break;
 313           }
 314           return false;
 315   }
 316
 317   /**
 318    * Compute all or part of the annotation row from the given consensus
 319    * hashtable
 320    *
 321    * @param consensus
 322    *          - pre-allocated annotation row
 323    * @param hconsensus
 324    * @param iStart
 325    * @param width
 326    * @param ignoreGapsInConsensusCalculation
 327    * @param includeAllConsSymbols
 328    */
 329   public static void completeConsensus(AlignmentAnnotation consensus,
 330           Hashtable[] hconsensus, int iStart, int width,
 331           boolean ignoreGapsInConsensusCalculation,
 332           boolean includeAllConsSymbols)
 333   {
 334     completeConsensus(consensus, hconsensus, iStart, width,
 335             ignoreGapsInConsensusCalculation, includeAllConsSymbols, null); // new
 336                                                                             // char[]
 337     // { 'A', 'C', 'G', 'T', 'U' });
 338   }
 339
 340   public static void completeConsensus(AlignmentAnnotation consensus,
 341           Hashtable[] hconsensus, int iStart, int width,
 342           boolean ignoreGapsInConsensusCalculation,
 343           boolean includeAllConsSymbols, char[] alphabet)
 344   {
 345     float tval, value;
 346     if (consensus == null || consensus.annotations == null
 347             || consensus.annotations.length < width)
 348     {
 349       // called with a bad alignment annotation row - wait for it to be
 350       // initialised properly
 351       return;
 352     }
 353     for (int i = iStart; i < width; i++)
 354     {
 355       if (i >= hconsensus.length)
 356       {
 357         // happens if sequences calculated over were shorter than alignment
 358         // width
 359         consensus.annotations[i] = null;
 360         continue;
 361       }
 362       value = 0;
 363       if (ignoreGapsInConsensusCalculation)
 364       {
 365         value = ((Float) hconsensus[i].get(StructureFrequency.PID_NOGAPS))
 366                 .floatValue();
 367       }
 368       else
 369       {
 370         value = ((Float) hconsensus[i].get(StructureFrequency.PID_GAPS))
 371                 .floatValue();
 372       }
 373
 374       String maxRes = hconsensus[i].get(StructureFrequency.MAXRESIDUE).toString();
 375       String mouseOver = hconsensus[i].get(StructureFrequency.MAXRESIDUE) + " ";
 376       if (maxRes.length() > 1)
 377       {
 378         mouseOver = "[" + maxRes + "] ";
 379         maxRes = "+";
 380       }
 381       int[][] profile = (int[][]) hconsensus[i].get(StructureFrequency.PROFILE);
 382       if (profile != null && includeAllConsSymbols)
 383       {
 384         mouseOver = "";
 385         if (alphabet != null)
 386         {
 387           for (int c = 0; c < alphabet.length; c++)
 388           {
 389             tval = ((float) profile[0][alphabet[c]])
 390                     * 100f
 391                     / (float) profile[1][ignoreGapsInConsensusCalculation ? 1
 392                             : 0];
 393             mouseOver += ((c == 0) ? "" : "; ") + alphabet[c] + " "
 394                     + ((int) tval) + "%";
 395           }
 396         }
 397         else
 398         {
 399           Object[] ca = new Object[profile[0].length];
 400           float[] vl = new float[profile[0].length];
 401           for (int c = 0; c < ca.length; c++)
 402           {
 403             ca[c] = new char[]
 404             { (char) c };
 405             vl[c] = (float) profile[0][c];
 406           }
 407           ;
 408           jalview.util.QuickSort.sort(vl, ca);
 409           for (int p = 0, c = ca.length - 1; profile[0][((char[]) ca[c])[0]] > 0; c--)
 410           {
 411             if (((char[]) ca[c])[0] != '-')
 412             {
 413               tval = ((float) profile[0][((char[]) ca[c])[0]])
 414                       * 100f
 415                       / (float) profile[1][ignoreGapsInConsensusCalculation ? 1
 416                               : 0];
 417               mouseOver += ((p == 0) ? "" : "; ") + ((char[]) ca[c])[0]
 418                       + " " + ((int) tval) + "%";
 419               p++;
 420
 421             }
 422           }
 423
 424         }
 425       }
 426       else
 427       {
 428         mouseOver += ((int) value + "%");
 429       }
 430       consensus.annotations[i] = new Annotation(maxRes, mouseOver, ' ',
 431               value);
 432     }
 433   }
 434
 435   /**
 436    * get the sorted profile for the given position of the consensus
 437    *
 438    * @param hconsensus
 439    * @return
 440    */
 441   public static int[] extractProfile(Hashtable hconsensus,
 442           boolean ignoreGapsInConsensusCalculation)
 443   {
 444     int[] rtnval = new int[64];
 445     int[][] profile = (int[][]) hconsensus.get(StructureFrequency.PROFILE);
 446     if (profile == null)
 447       return null;
 448     Object[] ca = new Object[profile[0].length];
 449     float[] vl = new float[profile[0].length];
 450     for (int c = 0; c < ca.length; c++)
 451     {
 452       ca[c] = new char[]
 453       { (char) c };
 454       vl[c] = (float) profile[0][c];
 455     }
 456     ;
 457     jalview.util.QuickSort.sort(vl, ca);
 458     rtnval[0] = 1;
 459     for (int c = ca.length - 1; profile[0][((char[]) ca[c])[0]] > 0; c--)
 460     {
 461       if (((char[]) ca[c])[0] != '-')
 462       {
 463         rtnval[rtnval[0]++] = ((char[]) ca[c])[0];
 464         rtnval[rtnval[0]++] = (int) (((float) profile[0][((char[]) ca[c])[0]]) * 100f / (float) profile[1][ignoreGapsInConsensusCalculation ? 1
 465                 : 0]);
 466       }
 467     }
 468     return rtnval;
 469   }
 470
 471   enum base {A,T,g,C};
 472
 473
 474   public static void main(String args[]){
 475           //Short test to see if checkBpType works
 476           ArrayList<String> test = new ArrayList<String>();
 477           test.add("A");
 478           test.add("c");
 479           test.add("g");
 480           test.add("T");
 481           test.add("U");
 482           for (String i : test) {
 483                   for (String j : test) {
 484                           System.out.println(i+"-"+j+": "+StructureFrequency.checkBpType(i.charAt(0),j.charAt(0)));
 485                   }
 486           }
 487   }
 488 }