JAL-2994 put ‘\’ first in character class clause of regex - otherwise doesn’t compile...
[jalview.git] / src / jalview / io / TCoffeeScoreFile.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.io;
22
23 import jalview.analysis.SequenceIdMatcher;
24 import jalview.datamodel.AlignmentAnnotation;
25 import jalview.datamodel.AlignmentI;
26 import jalview.datamodel.Annotation;
27 import jalview.datamodel.SequenceI;
28
29 import java.awt.Color;
30 import java.io.IOException;
31 import java.util.ArrayList;
32 import java.util.HashMap;
33 import java.util.LinkedHashMap;
34 import java.util.List;
35 import java.util.Map;
36 import java.util.regex.Matcher;
37 import java.util.regex.Pattern;
38
39 /**
40  * A file parser for T-Coffee score ascii format. This file contains the
41  * alignment consensus for each residue in any sequence.
42  * <p>
43  * This file is produced by <code>t_coffee</code> providing the option
44  * <code>-output=score_ascii </code> to the program command line
45  * 
46  * An example file is the following
47  * 
48  * <pre>
49  * T-COFFEE, Version_9.02.r1228 (2012-02-16 18:15:12 - Revision 1228 - Build 336)
50  * Cedric Notredame 
51  * CPU TIME:0 sec.
52  * SCORE=90
53  * *
54  *  BAD AVG GOOD
55  * *
56  * 1PHT   :  89
57  * 1BB9   :  90
58  * 1UHC   :  94
59  * 1YCS   :  94
60  * 1OOT   :  93
61  * 1ABO   :  94
62  * 1FYN   :  94
63  * 1QCF   :  94
64  * cons   :  90
65  * 
66  * 1PHT   999999999999999999999999998762112222543211112134
67  * 1BB9   99999999999999999999999999987-------4322----2234
68  * 1UHC   99999999999999999999999999987-------5321----2246
69  * 1YCS   99999999999999999999999999986-------4321----1-35
70  * 1OOT   999999999999999999999999999861-------3------1135
71  * 1ABO   99999999999999999999999999986-------422-------34
72  * 1FYN   99999999999999999999999999985-------32--------35
73  * 1QCF   99999999999999999999999999974-------2---------24
74  * cons   999999999999999999999999999851000110321100001134
75  * 
76  * 
77  * 1PHT   ----------5666642367889999999999889
78  * 1BB9   1111111111676653-355679999999999889
79  * 1UHC   ----------788774--66789999999999889
80  * 1YCS   ----------78777--356789999999999889
81  * 1OOT   ----------78877--356789999999997-67
82  * 1ABO   ----------687774--56779999999999889
83  * 1FYN   ----------6888842356789999999999889
84  * 1QCF   ----------6878742356789999999999889
85  * cons   00100000006877641356789999999999889
86  * </pre>
87  * 
88  * 
89  * @author Paolo Di Tommaso
90  * 
91  */
92 public class TCoffeeScoreFile extends AlignFile
93 {
94
95   /**
96    * TCOFFEE score colourscheme
97    */
98   static final Color[] colors = { new Color(102, 102, 255), // 0: lilac #6666FF
99       new Color(0, 255, 0), // 1: green #00FF00
100       new Color(102, 255, 0), // 2: lime green #66FF00
101       new Color(204, 255, 0), // 3: greeny yellow #CCFF00
102       new Color(255, 255, 0), // 4: yellow #FFFF00
103       new Color(255, 204, 0), // 5: orange #FFCC00
104       new Color(255, 153, 0), // 6: deep orange #FF9900
105       new Color(255, 102, 0), // 7: ochre #FF6600
106       new Color(255, 51, 0), // 8: red #FF3300
107       new Color(255, 34, 0) // 9: redder #FF2000
108   };
109
110   public final static String TCOFFEE_SCORE = "TCoffeeScore";
111
112   static Pattern SCORES_WITH_RESIDUE_NUMS = Pattern
113           .compile("^\\d+\\s([^\\s]+)\\s+\\d+$");
114
115   /** The {@link Header} structure holder */
116   Header header;
117
118   /**
119    * Holds the consensues values for each sequences. It uses a LinkedHashMap to
120    * maintaint the insertion order.
121    */
122   LinkedHashMap<String, StringBuilder> scores;
123
124   Integer fWidth;
125
126   public TCoffeeScoreFile(String inFile, DataSourceType fileSourceType)
127           throws IOException
128   {
129     super(inFile, fileSourceType);
130
131   }
132
133   public TCoffeeScoreFile(FileParse source) throws IOException
134   {
135     super(source);
136   }
137
138   /**
139    * Parse the provided reader for the T-Coffee scores file format
140    * 
141    * @param reader
142    *          public static TCoffeeScoreFile load(Reader reader) {
143    * 
144    *          try { BufferedReader in = (BufferedReader) (reader instanceof
145    *          BufferedReader ? reader : new BufferedReader(reader));
146    *          TCoffeeScoreFile result = new TCoffeeScoreFile();
147    *          result.doParsing(in); return result.header != null &&
148    *          result.scores != null ? result : null; } catch( Exception e) {
149    *          throw new RuntimeException(e); } }
150    */
151
152   /**
153    * @return The 'height' of the score matrix i.e. the numbers of score rows
154    *         that should matches the number of sequences in the alignment
155    */
156   public int getHeight()
157   {
158     // the last entry will always be the 'global' alingment consensus scores, so
159     // it is removed
160     // from the 'height' count to make this value compatible with the number of
161     // sequences in the MSA
162     return scores != null && scores.size() > 0 ? scores.size() - 1 : 0;
163   }
164
165   /**
166    * @return The 'width' of the score matrix i.e. the number of columns. Since
167    *         the score value are supposed to be calculated for an 'aligned' MSA,
168    *         all the entries have to have the same width.
169    */
170   public int getWidth()
171   {
172     return fWidth != null ? fWidth : 0;
173   }
174
175   /**
176    * Get the string of score values for the specified seqeunce ID.
177    * 
178    * @param id
179    *          The sequence ID
180    * @return The scores as a string of values e.g. {@code 99999987-------432}.
181    *         It return an empty string when the specified ID is missing.
182    */
183   public String getScoresFor(String id)
184   {
185     return scores != null && scores.containsKey(id)
186             ? scores.get(id).toString()
187             : "";
188   }
189
190   /**
191    * @return The list of score string as a {@link List} object, in the same
192    *         ordeer of the insertion i.e. in the MSA
193    */
194   public List<String> getScoresList()
195   {
196     if (scores == null)
197     {
198       return null;
199     }
200     List<String> result = new ArrayList<String>(scores.size());
201     for (Map.Entry<String, StringBuilder> it : scores.entrySet())
202     {
203       result.add(it.getValue().toString());
204     }
205
206     return result;
207   }
208
209   /**
210    * @return The parsed score values a matrix of bytes
211    */
212   public byte[][] getScoresArray()
213   {
214     if (scores == null)
215     {
216       return null;
217     }
218     byte[][] result = new byte[scores.size()][];
219
220     int rowCount = 0;
221     for (Map.Entry<String, StringBuilder> it : scores.entrySet())
222     {
223       String line = it.getValue().toString();
224       byte[] seqValues = new byte[line.length()];
225       for (int j = 0, c = line.length(); j < c; j++)
226       {
227
228         byte val = (byte) (line.charAt(j) - '0');
229
230         seqValues[j] = (val >= 0 && val <= 9) ? val : -1;
231       }
232
233       result[rowCount++] = seqValues;
234     }
235
236     return result;
237   }
238
239   @Override
240   public void parse() throws IOException
241   {
242     /*
243      * read the header
244      */
245     header = readHeader(this);
246
247     if (header == null)
248     {
249       error = true;
250       return;
251     }
252     scores = new LinkedHashMap<String, StringBuilder>();
253
254     /*
255      * initilize the structure
256      */
257     for (Map.Entry<String, Integer> entry : header.scores.entrySet())
258     {
259       scores.put(entry.getKey(), new StringBuilder());
260     }
261
262     /*
263      * go with the reading
264      */
265     Block block;
266     while ((block = readBlock(this, header.scores.size())) != null)
267     {
268
269       /*
270        * append sequences read in the block
271        */
272       for (Map.Entry<String, String> entry : block.items.entrySet())
273       {
274         StringBuilder scoreStringBuilder = scores.get(entry.getKey());
275         if (scoreStringBuilder == null)
276         {
277           error = true;
278           errormessage = String.format(
279                   "Invalid T-Coffee score file: Sequence ID '%s' is not declared in header section",
280                   entry.getKey());
281           return;
282         }
283
284         scoreStringBuilder.append(entry.getValue());
285       }
286     }
287
288     /*
289      * verify that all rows have the same width
290      */
291     for (StringBuilder str : scores.values())
292     {
293       if (fWidth == null)
294       {
295         fWidth = str.length();
296       }
297       else if (fWidth != str.length())
298       {
299         error = true;
300         errormessage = "Invalid T-Coffee score file: All the score sequences must have the same length";
301         return;
302       }
303     }
304
305     return;
306   }
307
308   static int parseInt(String str)
309   {
310     try
311     {
312       return Integer.parseInt(str);
313     } catch (NumberFormatException e)
314     {
315       // TODO report a warning ?
316       return 0;
317     }
318   }
319
320   /**
321    * Reaad the header section in the T-Coffee score file format
322    * 
323    * @param reader
324    *          The scores reader
325    * @return The parser {@link Header} instance
326    * @throws RuntimeException
327    *           when the header is not in the expected format
328    */
329   static Header readHeader(FileParse reader) throws IOException
330   {
331
332     Header result = null;
333     try
334     {
335       result = new Header();
336       result.head = reader.nextLine();
337
338       String line;
339
340       while ((line = reader.nextLine()) != null)
341       {
342         if (line.startsWith("SCORE="))
343         {
344           result.score = parseInt(line.substring(6).trim());
345           break;
346         }
347       }
348
349       if ((line = reader.nextLine()) == null || !"*".equals(line.trim()))
350       {
351         error(reader,
352                 "Invalid T-COFFEE score format (NO BAD/AVG/GOOD header)");
353         return null;
354       }
355       if ((line = reader.nextLine()) == null
356               || !"BAD AVG GOOD".equals(line.trim()))
357       {
358         error(reader,
359                 "Invalid T-COFFEE score format (NO BAD/AVG/GOOD header)");
360         return null;
361       }
362       if ((line = reader.nextLine()) == null || !"*".equals(line.trim()))
363       {
364         error(reader,
365                 "Invalid T-COFFEE score format (NO BAD/AVG/GOOD header)");
366         return null;
367       }
368
369       /*
370        * now are expected a list if sequences ID up to the first blank line
371        */
372       while ((line = reader.nextLine()) != null)
373       {
374         if ("".equals(line))
375         {
376           break;
377         }
378
379         int p = line.indexOf(":");
380         if (p == -1)
381         {
382           // TODO report a warning
383           continue;
384         }
385
386         String id = line.substring(0, p).trim();
387         int val = parseInt(line.substring(p + 1).trim());
388         if ("".equals(id))
389         {
390           // TODO report warning
391           continue;
392         }
393
394         result.scores.put(id, val);
395       }
396
397       if (result == null)
398       {
399         error(reader, "T-COFFEE score file had no per-sequence scores");
400       }
401
402     } catch (IOException e)
403     {
404       error(reader, "Unexpected problem parsing T-Coffee score ascii file");
405       throw e;
406     }
407
408     return result;
409   }
410
411   private static void error(FileParse reader, String errm)
412   {
413     reader.error = true;
414     if (reader.errormessage == null)
415     {
416       reader.errormessage = errm;
417     }
418     else
419     {
420       reader.errormessage += "\n" + errm;
421     }
422   }
423
424   /**
425    * Read a scores block ihe provided stream.
426    * 
427    * @param reader
428    *          The stream to parse
429    * @param size
430    *          The expected number of the sequence to be read
431    * @return The {@link Block} instance read or {link null} null if the end of
432    *         file has reached.
433    * @throws IOException
434    *           Something went wrong on the 'wire'
435    */
436   static Block readBlock(FileParse reader, int size) throws IOException
437   {
438     Block result = new Block(size);
439     String line;
440
441     /*
442      * read blank lines (eventually)
443      */
444     while ((line = reader.nextLine()) != null && "".equals(line.trim()))
445     {
446       // consume blank lines
447     }
448
449     if (line == null)
450     {
451       return null;
452     }
453
454     /*
455      * read the scores block
456      */
457     do
458     {
459       if ("".equals(line.trim()))
460       {
461         // terminated
462         break;
463       }
464
465       // split the line on the first blank
466       // the first part have to contain the sequence id
467       // the remaining part are the scores values
468       int p = line.indexOf(" ");
469       if (p == -1)
470       {
471         if (reader.warningMessage == null)
472         {
473           reader.warningMessage = "";
474         }
475         reader.warningMessage += "Possible parsing error - expected to find a space in line: '"
476                 + line + "'\n";
477         continue;
478       }
479
480       String id = line.substring(0, p).trim();
481       String val = line.substring(p + 1).trim();
482
483       Matcher m = SCORES_WITH_RESIDUE_NUMS.matcher(val);
484       if (m.matches())
485       {
486         val = m.group(1);
487       }
488
489       result.items.put(id, val);
490
491     } while ((line = reader.nextLine()) != null);
492
493     return result;
494   }
495
496   /*
497    * The score file header
498    */
499   static class Header
500   {
501     String head;
502
503     int score;
504
505     LinkedHashMap<String, Integer> scores = new LinkedHashMap<String, Integer>();
506
507     public int getScoreAvg()
508     {
509       return score;
510     }
511
512     public int getScoreFor(String ID)
513     {
514
515       return scores.containsKey(ID) ? scores.get(ID) : -1;
516
517     }
518   }
519
520   /*
521    * Hold a single block values block in the score file
522    */
523   static class Block
524   {
525     int size;
526
527     Map<String, String> items;
528
529     public Block(int size)
530     {
531       this.size = size;
532       this.items = new HashMap<String, String>(size);
533     }
534
535     String getScoresFor(String id)
536     {
537       return items.get(id);
538     }
539
540     String getConsensus()
541     {
542       return items.get("cons");
543     }
544   }
545
546   /**
547    * generate annotation for this TCoffee score set on the given alignment
548    * 
549    * @param al
550    *          alignment to annotate
551    * @param matchids
552    *          if true, annotate sequences based on matching sequence names
553    * @return true if alignment annotation was modified, false otherwise.
554    */
555   public boolean annotateAlignment(AlignmentI al, boolean matchids)
556   {
557     if (al.getHeight() != getHeight() || al.getWidth() != getWidth())
558     {
559       String info = String.format(
560               "align w: %s, h: %s; score: w: %s; h: %s ", al.getWidth(),
561               al.getHeight(), getWidth(), getHeight());
562       warningMessage = "Alignment shape does not match T-Coffee score file shape -- "
563               + info;
564       return false;
565     }
566     boolean added = false;
567     int i = 0;
568     SequenceIdMatcher sidmatcher = new SequenceIdMatcher(
569             al.getSequencesArray());
570     byte[][] scoreMatrix = getScoresArray();
571     // for 2.8 - we locate any existing TCoffee annotation and remove it first
572     // before adding this.
573     for (Map.Entry<String, StringBuilder> id : scores.entrySet())
574     {
575       byte[] srow = scoreMatrix[i];
576       SequenceI s;
577       if (matchids)
578       {
579         s = sidmatcher.findIdMatch(id.getKey());
580       }
581       else
582       {
583         s = al.getSequenceAt(i);
584       }
585       i++;
586       if (s == null && i != scores.size() && !id.getKey().equals("cons"))
587       {
588         System.err
589                 .println("No " + (matchids ? "match " : " sequences left ")
590                         + " for TCoffee score set : " + id.getKey());
591         continue;
592       }
593       int jSize = al.getWidth() < srow.length ? al.getWidth() : srow.length;
594       Annotation[] annotations = new Annotation[al.getWidth()];
595       for (int j = 0; j < jSize; j++)
596       {
597         byte val = srow[j];
598         if (s != null && jalview.util.Comparison.isGap(s.getCharAt(j)))
599         {
600           annotations[j] = null;
601           if (val > 0)
602           {
603             System.err.println(
604                     "Warning: non-zero value for positional T-COFFEE score for gap at "
605                             + j + " in sequence " + s.getName());
606           }
607         }
608         else
609         {
610           annotations[j] = new Annotation(s == null ? "" + val : null,
611                   s == null ? "" + val : null, '\0', val * 1f,
612                   val >= 0 && val < colors.length ? colors[val]
613                           : Color.white);
614         }
615       }
616       // this will overwrite any existing t-coffee scores for the alignment
617       AlignmentAnnotation aa = al.findOrCreateAnnotation(TCOFFEE_SCORE,
618               TCOFFEE_SCORE, false, s, null);
619       if (s != null)
620       {
621         aa.label = "T-COFFEE";
622         aa.description = "" + id.getKey();
623         aa.annotations = annotations;
624         aa.visible = false;
625         aa.belowAlignment = false;
626         aa.setScore(header.getScoreFor(id.getKey()));
627         aa.createSequenceMapping(s, s.getStart(), true);
628         s.addAlignmentAnnotation(aa);
629         aa.adjustForAlignment();
630       }
631       else
632       {
633         aa.graph = AlignmentAnnotation.NO_GRAPH;
634         aa.label = "T-COFFEE";
635         aa.description = "TCoffee column reliability score";
636         aa.annotations = annotations;
637         aa.belowAlignment = true;
638         aa.visible = true;
639         aa.setScore(header.getScoreAvg());
640       }
641       aa.showAllColLabels = true;
642       aa.validateRangeAndDisplay();
643       added = true;
644     }
645
646     return added;
647   }
648
649   @Override
650   public String print(SequenceI[] sqs, boolean jvsuffix)
651   {
652     // TODO Auto-generated method stub
653     return "Not valid.";
654   }
655 }