forester/java/src/org/forester/surfacing/SurfacingUtil.java

   1 // $Id:
   2 //
   3 // FORESTER -- software libraries and applications
   4 // for evolutionary biology research and applications.
   5 //
   6 // Copyright (C) 2008-2009 Christian M. Zmasek
   7 // Copyright (C) 2008-2009 Burnham Institute for Medical Research
   8 // All rights reserved
   9 //
  10 // This library is free software; you can redistribute it and/or
  11 // modify it under the terms of the GNU Lesser General Public
  12 // License as published by the Free Software Foundation; either
  13 // version 2.1 of the License, or (at your option) any later version.
  14 //
  15 // This library is distributed in the hope that it will be useful,
  16 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18 // Lesser General Public License for more details.
  19 //
  20 // You should have received a copy of the GNU Lesser General Public
  21 // License along with this library; if not, write to the Free Software
  22 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  23 //
  24 // Contact: phylosoft @ gmail . com
  25 // WWW: www.phylosoft.org/forester
  26
  27 package org.forester.surfacing;
  28
  29 import java.io.BufferedWriter;
  30 import java.io.File;
  31 import java.io.FileWriter;
  32 import java.io.IOException;
  33 import java.io.Writer;
  34 import java.text.DecimalFormat;
  35 import java.text.NumberFormat;
  36 import java.util.ArrayList;
  37 import java.util.Arrays;
  38 import java.util.Collections;
  39 import java.util.Comparator;
  40 import java.util.HashMap;
  41 import java.util.HashSet;
  42 import java.util.List;
  43 import java.util.Map;
  44 import java.util.Map.Entry;
  45 import java.util.PriorityQueue;
  46 import java.util.Set;
  47 import java.util.SortedMap;
  48 import java.util.SortedSet;
  49 import java.util.TreeMap;
  50 import java.util.TreeSet;
  51 import java.util.regex.Matcher;
  52 import java.util.regex.Pattern;
  53
  54 import org.forester.application.surfacing;
  55 import org.forester.evoinference.distance.NeighborJoining;
  56 import org.forester.evoinference.matrix.character.BasicCharacterStateMatrix;
  57 import org.forester.evoinference.matrix.character.CharacterStateMatrix;
  58 import org.forester.evoinference.matrix.character.CharacterStateMatrix.BinaryStates;
  59 import org.forester.evoinference.matrix.character.CharacterStateMatrix.Format;
  60 import org.forester.evoinference.matrix.character.CharacterStateMatrix.GainLossStates;
  61 import org.forester.evoinference.matrix.distance.BasicSymmetricalDistanceMatrix;
  62 import org.forester.evoinference.matrix.distance.DistanceMatrix;
  63 import org.forester.go.GoId;
  64 import org.forester.go.GoNameSpace;
  65 import org.forester.go.GoTerm;
  66 import org.forester.go.PfamToGoMapping;
  67 import org.forester.io.parsers.nexus.NexusConstants;
  68 import org.forester.io.writers.PhylogenyWriter;
  69 import org.forester.msa.MsaCompactor.SORT_BY;
  70 import org.forester.phylogeny.Phylogeny;
  71 import org.forester.phylogeny.PhylogenyMethods;
  72 import org.forester.phylogeny.PhylogenyNode;
  73 import org.forester.phylogeny.PhylogenyNodeI.NH_CONVERSION_SUPPORT_VALUE_STYLE;
  74 import org.forester.phylogeny.data.BinaryCharacters;
  75 import org.forester.phylogeny.data.Confidence;
  76 import org.forester.phylogeny.iterators.PhylogenyNodeIterator;
  77 import org.forester.protein.BasicDomain;
  78 import org.forester.protein.BasicProtein;
  79 import org.forester.protein.BinaryDomainCombination;
  80 import org.forester.protein.Domain;
  81 import org.forester.protein.DomainId;
  82 import org.forester.protein.Protein;
  83 import org.forester.species.Species;
  84 import org.forester.surfacing.DomainSimilarityCalculator.Detailedness;
  85 import org.forester.surfacing.DomainSimilarityCalculator.GoAnnotationOutput;
  86 import org.forester.surfacing.GenomeWideCombinableDomains.GenomeWideCombinableDomainsSortOrder;
  87 import org.forester.util.AsciiHistogram;
  88 import org.forester.util.BasicDescriptiveStatistics;
  89 import org.forester.util.BasicTable;
  90 import org.forester.util.BasicTableParser;
  91 import org.forester.util.DescriptiveStatistics;
  92 import org.forester.util.ForesterUtil;
  93
  94 public final class SurfacingUtil {
  95
  96     private final static NumberFormat       FORMATTER                        = new DecimalFormat( "0.0E0" );
  97     private final static NumberFormat       FORMATTER_3                      = new DecimalFormat( "0.000" );
  98     private static final Comparator<Domain> ASCENDING_CONFIDENCE_VALUE_ORDER = new Comparator<Domain>() {
  99
 100                                                                                  @Override
 101                                                                                  public int compare( final Domain d1,
 102                                                                                                      final Domain d2 ) {
 103                                                                                      if ( d1.getPerSequenceEvalue() < d2
 104                                                                                              .getPerSequenceEvalue() ) {
 105                                                                                          return -1;
 106                                                                                      }
 107                                                                                      else if ( d1
 108                                                                                              .getPerSequenceEvalue() > d2
 109                                                                                              .getPerSequenceEvalue() ) {
 110                                                                                          return 1;
 111                                                                                      }
 112                                                                                      else {
 113                                                                                          return d1.compareTo( d2 );
 114                                                                                      }
 115                                                                                  }
 116                                                                              };
 117     public final static Pattern             PATTERN_SP_STYLE_TAXONOMY        = Pattern.compile( "^[A-Z0-9]{3,5}$" );
 118     private static final boolean            USE_LAST                         = true;
 119
 120     private SurfacingUtil() {
 121         // Hidden constructor.
 122     }
 123
 124     public static void addAllBinaryDomainCombinationToSet( final GenomeWideCombinableDomains genome,
 125                                                            final SortedSet<BinaryDomainCombination> binary_domain_combinations ) {
 126         final SortedMap<DomainId, CombinableDomains> all_cd = genome.getAllCombinableDomainsIds();
 127         for( final DomainId domain_id : all_cd.keySet() ) {
 128             binary_domain_combinations.addAll( all_cd.get( domain_id ).toBinaryDomainCombinations() );
 129         }
 130     }
 131
 132     public static void addAllDomainIdsToSet( final GenomeWideCombinableDomains genome,
 133                                              final SortedSet<DomainId> domain_ids ) {
 134         final SortedSet<DomainId> domains = genome.getAllDomainIds();
 135         for( final DomainId domain : domains ) {
 136             domain_ids.add( domain );
 137         }
 138     }
 139
 140     public static void addHtmlHead( final Writer w, final String title ) throws IOException {
 141         w.write( SurfacingConstants.NL );
 142         w.write( "<head>" );
 143         w.write( "<title>" );
 144         w.write( title );
 145         w.write( "</title>" );
 146         w.write( SurfacingConstants.NL );
 147         w.write( "<style>" );
 148         w.write( SurfacingConstants.NL );
 149         w.write( "a:visited { color : #6633FF; text-decoration : none; }" );
 150         w.write( SurfacingConstants.NL );
 151         w.write( "a:link { color : #6633FF; text-decoration : none; }" );
 152         w.write( SurfacingConstants.NL );
 153         w.write( "a:active { color : #99FF00; text-decoration : none; }" );
 154         w.write( SurfacingConstants.NL );
 155         w.write( "a:hover { color : #FFFFFF; background-color : #99FF00; text-decoration : none; }" );
 156         w.write( SurfacingConstants.NL );
 157         w.write( "td { text-align: left; vertical-align: top; font-family: Verdana, Arial, Helvetica; font-size: 8pt}" );
 158         w.write( SurfacingConstants.NL );
 159         w.write( "h1 { color : #0000FF; font-family: Verdana, Arial, Helvetica; font-size: 18pt; font-weight: bold }" );
 160         w.write( SurfacingConstants.NL );
 161         w.write( "h2 { color : #0000FF; font-family: Verdana, Arial, Helvetica; font-size: 16pt; font-weight: bold }" );
 162         w.write( SurfacingConstants.NL );
 163         w.write( "</style>" );
 164         w.write( SurfacingConstants.NL );
 165         w.write( "</head>" );
 166         w.write( SurfacingConstants.NL );
 167     }
 168
 169     public static DescriptiveStatistics calculateDescriptiveStatisticsForMeanValues( final Set<DomainSimilarity> similarities ) {
 170         final DescriptiveStatistics stats = new BasicDescriptiveStatistics();
 171         for( final DomainSimilarity similarity : similarities ) {
 172             stats.addValue( similarity.getMeanSimilarityScore() );
 173         }
 174         return stats;
 175     }
 176
 177     private static void calculateIndependentDomainCombinationGains( final Phylogeny local_phylogeny_l,
 178                                                                     final String outfilename_for_counts,
 179                                                                     final String outfilename_for_dc,
 180                                                                     final String outfilename_for_dc_for_go_mapping,
 181                                                                     final String outfilename_for_dc_for_go_mapping_unique,
 182                                                                     final String outfilename_for_rank_counts,
 183                                                                     final String outfilename_for_ancestor_species_counts,
 184                                                                     final String outfilename_for_protein_stats,
 185                                                                     final Map<String, DescriptiveStatistics> protein_length_stats_by_dc,
 186                                                                     final Map<String, DescriptiveStatistics> domain_number_stats_by_dc,
 187                                                                     final Map<String, DescriptiveStatistics> domain_length_stats_by_domain ) {
 188         try {
 189             //
 190             //            if ( protein_length_stats_by_dc != null ) {
 191             //                for( final Entry<?, DescriptiveStatistics> entry : protein_length_stats_by_dc.entrySet() ) {
 192             //                    System.out.print( entry.getKey().toString() );
 193             //                    System.out.print( ": " );
 194             //                    double[] a = entry.getValue().getDataAsDoubleArray();
 195             //                    for( int i = 0; i < a.length; i++ ) {
 196             //                        System.out.print( a[ i ] + " " );
 197             //                    }
 198             //                    System.out.println();
 199             //                }
 200             //            }
 201             //            if ( domain_number_stats_by_dc != null ) {
 202             //                for( final Entry<?, DescriptiveStatistics> entry : domain_number_stats_by_dc.entrySet() ) {
 203             //                    System.out.print( entry.getKey().toString() );
 204             //                    System.out.print( ": " );
 205             //                    double[] a = entry.getValue().getDataAsDoubleArray();
 206             //                    for( int i = 0; i < a.length; i++ ) {
 207             //                        System.out.print( a[ i ] + " " );
 208             //                    }
 209             //                    System.out.println();
 210             //                }
 211             //            }
 212             //
 213             final BufferedWriter out_counts = new BufferedWriter( new FileWriter( outfilename_for_counts ) );
 214             final BufferedWriter out_dc = new BufferedWriter( new FileWriter( outfilename_for_dc ) );
 215             final BufferedWriter out_dc_for_go_mapping = new BufferedWriter( new FileWriter( outfilename_for_dc_for_go_mapping ) );
 216             final BufferedWriter out_dc_for_go_mapping_unique = new BufferedWriter( new FileWriter( outfilename_for_dc_for_go_mapping_unique ) );
 217             final SortedMap<String, Integer> dc_gain_counts = new TreeMap<String, Integer>();
 218             for( final PhylogenyNodeIterator it = local_phylogeny_l.iteratorPostorder(); it.hasNext(); ) {
 219                 final PhylogenyNode n = it.next();
 220                 final Set<String> gained_dc = n.getNodeData().getBinaryCharacters().getGainedCharacters();
 221                 for( final String dc : gained_dc ) {
 222                     if ( dc_gain_counts.containsKey( dc ) ) {
 223                         dc_gain_counts.put( dc, dc_gain_counts.get( dc ) + 1 );
 224                     }
 225                     else {
 226                         dc_gain_counts.put( dc, 1 );
 227                     }
 228                 }
 229             }
 230             final SortedMap<Integer, Integer> histogram = new TreeMap<Integer, Integer>();
 231             final SortedMap<Integer, StringBuilder> domain_lists = new TreeMap<Integer, StringBuilder>();
 232             final SortedMap<Integer, DescriptiveStatistics> dc_reapp_counts_to_protein_length_stats = new TreeMap<Integer, DescriptiveStatistics>();
 233             final SortedMap<Integer, DescriptiveStatistics> dc_reapp_counts_to_domain_number_stats = new TreeMap<Integer, DescriptiveStatistics>();
 234             final SortedMap<Integer, DescriptiveStatistics> dc_reapp_counts_to_domain_lengths_stats = new TreeMap<Integer, DescriptiveStatistics>();
 235             final SortedMap<Integer, PriorityQueue<String>> domain_lists_go = new TreeMap<Integer, PriorityQueue<String>>();
 236             final SortedMap<Integer, SortedSet<String>> domain_lists_go_unique = new TreeMap<Integer, SortedSet<String>>();
 237             final Set<String> dcs = dc_gain_counts.keySet();
 238             final SortedSet<String> more_than_once = new TreeSet<String>();
 239             final DescriptiveStatistics gained_once_lengths_stats = new BasicDescriptiveStatistics();
 240             final DescriptiveStatistics gained_once_domain_count_stats = new BasicDescriptiveStatistics();
 241             final DescriptiveStatistics gained_multiple_times_lengths_stats = new BasicDescriptiveStatistics();
 242             final DescriptiveStatistics gained_multiple_times_domain_count_stats = new BasicDescriptiveStatistics();
 243             long gained_multiple_times_domain_length_sum = 0;
 244             long gained_once_domain_length_sum = 0;
 245             long gained_multiple_times_domain_length_count = 0;
 246             long gained_once_domain_length_count = 0;
 247             for( final String dc : dcs ) {
 248                 final int count = dc_gain_counts.get( dc );
 249                 if ( histogram.containsKey( count ) ) {
 250                     histogram.put( count, histogram.get( count ) + 1 );
 251                     domain_lists.get( count ).append( ", " + dc );
 252                     domain_lists_go.get( count ).addAll( splitDomainCombination( dc ) );
 253                     domain_lists_go_unique.get( count ).addAll( splitDomainCombination( dc ) );
 254                 }
 255                 else {
 256                     histogram.put( count, 1 );
 257                     domain_lists.put( count, new StringBuilder( dc ) );
 258                     final PriorityQueue<String> q = new PriorityQueue<String>();
 259                     q.addAll( splitDomainCombination( dc ) );
 260                     domain_lists_go.put( count, q );
 261                     final SortedSet<String> set = new TreeSet<String>();
 262                     set.addAll( splitDomainCombination( dc ) );
 263                     domain_lists_go_unique.put( count, set );
 264                 }
 265                 if ( protein_length_stats_by_dc != null ) {
 266                     if ( !dc_reapp_counts_to_protein_length_stats.containsKey( count ) ) {
 267                         dc_reapp_counts_to_protein_length_stats.put( count, new BasicDescriptiveStatistics() );
 268                     }
 269                     dc_reapp_counts_to_protein_length_stats.get( count ).addValue( protein_length_stats_by_dc.get( dc )
 270                             .arithmeticMean() );
 271                 }
 272                 if ( domain_number_stats_by_dc != null ) {
 273                     if ( !dc_reapp_counts_to_domain_number_stats.containsKey( count ) ) {
 274                         dc_reapp_counts_to_domain_number_stats.put( count, new BasicDescriptiveStatistics() );
 275                     }
 276                     dc_reapp_counts_to_domain_number_stats.get( count ).addValue( domain_number_stats_by_dc.get( dc )
 277                             .arithmeticMean() );
 278                 }
 279                 if ( domain_length_stats_by_domain != null ) {
 280                     if ( !dc_reapp_counts_to_domain_lengths_stats.containsKey( count ) ) {
 281                         dc_reapp_counts_to_domain_lengths_stats.put( count, new BasicDescriptiveStatistics() );
 282                     }
 283                     final String[] ds = dc.split( "=" );
 284                     dc_reapp_counts_to_domain_lengths_stats.get( count ).addValue( domain_length_stats_by_domain
 285                             .get( ds[ 0 ] ).arithmeticMean() );
 286                     dc_reapp_counts_to_domain_lengths_stats.get( count ).addValue( domain_length_stats_by_domain
 287                             .get( ds[ 1 ] ).arithmeticMean() );
 288                 }
 289                 if ( count > 1 ) {
 290                     more_than_once.add( dc );
 291                     if ( protein_length_stats_by_dc != null ) {
 292                         final DescriptiveStatistics s = protein_length_stats_by_dc.get( dc );
 293                         for( final double element : s.getData() ) {
 294                             gained_multiple_times_lengths_stats.addValue( element );
 295                         }
 296                     }
 297                     if ( domain_number_stats_by_dc != null ) {
 298                         final DescriptiveStatistics s = domain_number_stats_by_dc.get( dc );
 299                         for( final double element : s.getData() ) {
 300                             gained_multiple_times_domain_count_stats.addValue( element );
 301                         }
 302                     }
 303                     if ( domain_length_stats_by_domain != null ) {
 304                         final String[] ds = dc.split( "=" );
 305                         final DescriptiveStatistics s0 = domain_length_stats_by_domain.get( ds[ 0 ] );
 306                         final DescriptiveStatistics s1 = domain_length_stats_by_domain.get( ds[ 1 ] );
 307                         for( final double element : s0.getData() ) {
 308                             gained_multiple_times_domain_length_sum += element;
 309                             ++gained_multiple_times_domain_length_count;
 310                         }
 311                         for( final double element : s1.getData() ) {
 312                             gained_multiple_times_domain_length_sum += element;
 313                             ++gained_multiple_times_domain_length_count;
 314                         }
 315                     }
 316                 }
 317                 else {
 318                     if ( protein_length_stats_by_dc != null ) {
 319                         final DescriptiveStatistics s = protein_length_stats_by_dc.get( dc );
 320                         for( final double element : s.getData() ) {
 321                             gained_once_lengths_stats.addValue( element );
 322                         }
 323                     }
 324                     if ( domain_number_stats_by_dc != null ) {
 325                         final DescriptiveStatistics s = domain_number_stats_by_dc.get( dc );
 326                         for( final double element : s.getData() ) {
 327                             gained_once_domain_count_stats.addValue( element );
 328                         }
 329                     }
 330                     if ( domain_length_stats_by_domain != null ) {
 331                         final String[] ds = dc.split( "=" );
 332                         final DescriptiveStatistics s0 = domain_length_stats_by_domain.get( ds[ 0 ] );
 333                         final DescriptiveStatistics s1 = domain_length_stats_by_domain.get( ds[ 1 ] );
 334                         for( final double element : s0.getData() ) {
 335                             gained_once_domain_length_sum += element;
 336                             ++gained_once_domain_length_count;
 337                         }
 338                         for( final double element : s1.getData() ) {
 339                             gained_once_domain_length_sum += element;
 340                             ++gained_once_domain_length_count;
 341                         }
 342                     }
 343                 }
 344             }
 345             final Set<Integer> histogram_keys = histogram.keySet();
 346             for( final Integer histogram_key : histogram_keys ) {
 347                 final int count = histogram.get( histogram_key );
 348                 final StringBuilder dc = domain_lists.get( histogram_key );
 349                 out_counts.write( histogram_key + "\t" + count + ForesterUtil.LINE_SEPARATOR );
 350                 out_dc.write( histogram_key + "\t" + dc + ForesterUtil.LINE_SEPARATOR );
 351                 out_dc_for_go_mapping.write( "#" + histogram_key + ForesterUtil.LINE_SEPARATOR );
 352                 final Object[] sorted = domain_lists_go.get( histogram_key ).toArray();
 353                 Arrays.sort( sorted );
 354                 for( final Object domain : sorted ) {
 355                     out_dc_for_go_mapping.write( domain + ForesterUtil.LINE_SEPARATOR );
 356                 }
 357                 out_dc_for_go_mapping_unique.write( "#" + histogram_key + ForesterUtil.LINE_SEPARATOR );
 358                 for( final String domain : domain_lists_go_unique.get( histogram_key ) ) {
 359                     out_dc_for_go_mapping_unique.write( domain + ForesterUtil.LINE_SEPARATOR );
 360                 }
 361             }
 362             out_counts.close();
 363             out_dc.close();
 364             out_dc_for_go_mapping.close();
 365             out_dc_for_go_mapping_unique.close();
 366             final SortedMap<String, Integer> lca_rank_counts = new TreeMap<String, Integer>();
 367             final SortedMap<String, Integer> lca_ancestor_species_counts = new TreeMap<String, Integer>();
 368             for( final String dc : more_than_once ) {
 369                 final List<PhylogenyNode> nodes = new ArrayList<PhylogenyNode>();
 370                 for( final PhylogenyNodeIterator it = local_phylogeny_l.iteratorExternalForward(); it.hasNext(); ) {
 371                     final PhylogenyNode n = it.next();
 372                     if ( n.getNodeData().getBinaryCharacters().getGainedCharacters().contains( dc ) ) {
 373                         nodes.add( n );
 374                     }
 375                 }
 376                 for( int i = 0; i < nodes.size() - 1; ++i ) {
 377                     for( int j = i + 1; j < nodes.size(); ++j ) {
 378                         final PhylogenyNode lca = PhylogenyMethods.obtainLCA( nodes.get( i ),
 379                                                                                             nodes.get( j ) );
 380                         String rank = "unknown";
 381                         if ( lca.getNodeData().isHasTaxonomy()
 382                                 && !ForesterUtil.isEmpty( lca.getNodeData().getTaxonomy().getRank() ) ) {
 383                             rank = lca.getNodeData().getTaxonomy().getRank();
 384                         }
 385                         addToCountMap( lca_rank_counts, rank );
 386                         String lca_species;
 387                         if ( lca.getNodeData().isHasTaxonomy()
 388                                 && !ForesterUtil.isEmpty( lca.getNodeData().getTaxonomy().getScientificName() ) ) {
 389                             lca_species = lca.getNodeData().getTaxonomy().getScientificName();
 390                         }
 391                         else if ( lca.getNodeData().isHasTaxonomy()
 392                                 && !ForesterUtil.isEmpty( lca.getNodeData().getTaxonomy().getCommonName() ) ) {
 393                             lca_species = lca.getNodeData().getTaxonomy().getCommonName();
 394                         }
 395                         else {
 396                             lca_species = lca.getName();
 397                         }
 398                         addToCountMap( lca_ancestor_species_counts, lca_species );
 399                     }
 400                 }
 401             }
 402             final BufferedWriter out_for_rank_counts = new BufferedWriter( new FileWriter( outfilename_for_rank_counts ) );
 403             final BufferedWriter out_for_ancestor_species_counts = new BufferedWriter( new FileWriter( outfilename_for_ancestor_species_counts ) );
 404             ForesterUtil.map2writer( out_for_rank_counts, lca_rank_counts, "\t", ForesterUtil.LINE_SEPARATOR );
 405             ForesterUtil.map2writer( out_for_ancestor_species_counts,
 406                                      lca_ancestor_species_counts,
 407                                      "\t",
 408                                      ForesterUtil.LINE_SEPARATOR );
 409             out_for_rank_counts.close();
 410             out_for_ancestor_species_counts.close();
 411             if ( !ForesterUtil.isEmpty( outfilename_for_protein_stats )
 412                     && ( ( domain_length_stats_by_domain != null ) || ( protein_length_stats_by_dc != null ) || ( domain_number_stats_by_dc != null ) ) ) {
 413                 final BufferedWriter w = new BufferedWriter( new FileWriter( outfilename_for_protein_stats ) );
 414                 w.write( "Domain Lengths: " );
 415                 w.write( "\n" );
 416                 if ( domain_length_stats_by_domain != null ) {
 417                     for( final Entry<Integer, DescriptiveStatistics> entry : dc_reapp_counts_to_domain_lengths_stats
 418                             .entrySet() ) {
 419                         w.write( entry.getKey().toString() );
 420                         w.write( "\t" + entry.getValue().arithmeticMean() );
 421                         w.write( "\t" + entry.getValue().median() );
 422                         w.write( "\n" );
 423                     }
 424                 }
 425                 w.flush();
 426                 w.write( "\n" );
 427                 w.write( "\n" );
 428                 w.write( "Protein Lengths: " );
 429                 w.write( "\n" );
 430                 if ( protein_length_stats_by_dc != null ) {
 431                     for( final Entry<Integer, DescriptiveStatistics> entry : dc_reapp_counts_to_protein_length_stats
 432                             .entrySet() ) {
 433                         w.write( entry.getKey().toString() );
 434                         w.write( "\t" + entry.getValue().arithmeticMean() );
 435                         w.write( "\t" + entry.getValue().median() );
 436                         w.write( "\n" );
 437                     }
 438                 }
 439                 w.flush();
 440                 w.write( "\n" );
 441                 w.write( "\n" );
 442                 w.write( "Number of domains: " );
 443                 w.write( "\n" );
 444                 if ( domain_number_stats_by_dc != null ) {
 445                     for( final Entry<Integer, DescriptiveStatistics> entry : dc_reapp_counts_to_domain_number_stats
 446                             .entrySet() ) {
 447                         w.write( entry.getKey().toString() );
 448                         w.write( "\t" + entry.getValue().arithmeticMean() );
 449                         w.write( "\t" + entry.getValue().median() );
 450                         w.write( "\n" );
 451                     }
 452                 }
 453                 w.flush();
 454                 w.write( "\n" );
 455                 w.write( "\n" );
 456                 w.write( "Gained once, domain lengths:" );
 457                 w.write( "\n" );
 458                 w.write( "N: " + gained_once_domain_length_count );
 459                 w.write( "\n" );
 460                 w.write( "Avg: " + ( ( double ) gained_once_domain_length_sum / gained_once_domain_length_count ) );
 461                 w.write( "\n" );
 462                 w.write( "\n" );
 463                 w.write( "Gained multiple times, domain lengths:" );
 464                 w.write( "\n" );
 465                 w.write( "N: " + gained_multiple_times_domain_length_count );
 466                 w.write( "\n" );
 467                 w.write( "Avg: "
 468                         + ( ( double ) gained_multiple_times_domain_length_sum / gained_multiple_times_domain_length_count ) );
 469                 w.write( "\n" );
 470                 w.write( "\n" );
 471                 w.write( "\n" );
 472                 w.write( "\n" );
 473                 w.write( "Gained once, protein lengths:" );
 474                 w.write( "\n" );
 475                 w.write( gained_once_lengths_stats.toString() );
 476                 w.write( "\n" );
 477                 w.write( "\n" );
 478                 w.write( "Gained once, domain counts:" );
 479                 w.write( "\n" );
 480                 w.write( gained_once_domain_count_stats.toString() );
 481                 w.write( "\n" );
 482                 w.write( "\n" );
 483                 w.write( "Gained multiple times, protein lengths:" );
 484                 w.write( "\n" );
 485                 w.write( gained_multiple_times_lengths_stats.toString() );
 486                 w.write( "\n" );
 487                 w.write( "\n" );
 488                 w.write( "Gained multiple times, domain counts:" );
 489                 w.write( "\n" );
 490                 w.write( gained_multiple_times_domain_count_stats.toString() );
 491                 w.flush();
 492                 w.close();
 493             }
 494         }
 495         catch ( final IOException e ) {
 496             ForesterUtil.printWarningMessage( surfacing.PRG_NAME, "Failure to write: " + e );
 497         }
 498         ForesterUtil.programMessage( surfacing.PRG_NAME, "Wrote independent domain combination gains fitch counts to ["
 499                 + outfilename_for_counts + "]" );
 500         ForesterUtil.programMessage( surfacing.PRG_NAME, "Wrote independent domain combination gains fitch lists to ["
 501                 + outfilename_for_dc + "]" );
 502         ForesterUtil.programMessage( surfacing.PRG_NAME,
 503                                      "Wrote independent domain combination gains fitch lists to (for GO mapping) ["
 504                                              + outfilename_for_dc_for_go_mapping + "]" );
 505         ForesterUtil.programMessage( surfacing.PRG_NAME,
 506                                      "Wrote independent domain combination gains fitch lists to (for GO mapping, unique) ["
 507                                              + outfilename_for_dc_for_go_mapping_unique + "]" );
 508     }
 509
 510     private final static void addToCountMap( final Map<String, Integer> map, final String s ) {
 511         if ( map.containsKey( s ) ) {
 512             map.put( s, map.get( s ) + 1 );
 513         }
 514         else {
 515             map.put( s, 1 );
 516         }
 517     }
 518
 519     public static int calculateOverlap( final Domain domain, final List<Boolean> covered_positions ) {
 520         int overlap_count = 0;
 521         for( int i = domain.getFrom(); i <= domain.getTo(); ++i ) {
 522             if ( ( i < covered_positions.size() ) && ( covered_positions.get( i ) == true ) ) {
 523                 ++overlap_count;
 524             }
 525         }
 526         return overlap_count;
 527     }
 528
 529     public static void checkForOutputFileWriteability( final File outfile ) {
 530         final String error = ForesterUtil.isWritableFile( outfile );
 531         if ( !ForesterUtil.isEmpty( error ) ) {
 532             ForesterUtil.fatalError( surfacing.PRG_NAME, error );
 533         }
 534     }
 535
 536     private static SortedSet<String> collectAllDomainsChangedOnSubtree( final PhylogenyNode subtree_root,
 537                                                                         final boolean get_gains ) {
 538         final SortedSet<String> domains = new TreeSet<String>();
 539         for( final PhylogenyNode descendant : PhylogenyMethods.getAllDescendants( subtree_root ) ) {
 540             final BinaryCharacters chars = descendant.getNodeData().getBinaryCharacters();
 541             if ( get_gains ) {
 542                 domains.addAll( chars.getGainedCharacters() );
 543             }
 544             else {
 545                 domains.addAll( chars.getLostCharacters() );
 546             }
 547         }
 548         return domains;
 549     }
 550
 551     public static void collectChangedDomainCombinationsFromBinaryStatesMatrixAsListToFile( final CharacterStateMatrix<CharacterStateMatrix.GainLossStates> matrix,
 552                                                                                            final BinaryDomainCombination.DomainCombinationType dc_type,
 553                                                                                            final List<BinaryDomainCombination> all_binary_domains_combination_gained,
 554                                                                                            final boolean get_gains ) {
 555         final SortedSet<String> sorted_ids = new TreeSet<String>();
 556         for( int i = 0; i < matrix.getNumberOfIdentifiers(); ++i ) {
 557             sorted_ids.add( matrix.getIdentifier( i ) );
 558         }
 559         for( final String id : sorted_ids ) {
 560             for( int c = 0; c < matrix.getNumberOfCharacters(); ++c ) {
 561                 if ( ( get_gains && ( matrix.getState( id, c ) == CharacterStateMatrix.GainLossStates.GAIN ) )
 562                         || ( !get_gains && ( matrix.getState( id, c ) == CharacterStateMatrix.GainLossStates.LOSS ) ) ) {
 563                     if ( dc_type == BinaryDomainCombination.DomainCombinationType.DIRECTED_ADJACTANT ) {
 564                         all_binary_domains_combination_gained.add( AdjactantDirectedBinaryDomainCombination
 565                                 .createInstance( matrix.getCharacter( c ) ) );
 566                     }
 567                     else if ( dc_type == BinaryDomainCombination.DomainCombinationType.DIRECTED ) {
 568                         all_binary_domains_combination_gained.add( DirectedBinaryDomainCombination
 569                                 .createInstance( matrix.getCharacter( c ) ) );
 570                     }
 571                     else {
 572                         all_binary_domains_combination_gained.add( BasicBinaryDomainCombination.createInstance( matrix
 573                                 .getCharacter( c ) ) );
 574                     }
 575                 }
 576             }
 577         }
 578     }
 579
 580     private static File createBaseDirForPerNodeDomainFiles( final String base_dir,
 581                                                             final boolean domain_combinations,
 582                                                             final CharacterStateMatrix.GainLossStates state,
 583                                                             final String outfile ) {
 584         File per_node_go_mapped_domain_gain_loss_files_base_dir = new File( new File( outfile ).getParent()
 585                 + ForesterUtil.FILE_SEPARATOR + base_dir );
 586         if ( !per_node_go_mapped_domain_gain_loss_files_base_dir.exists() ) {
 587             per_node_go_mapped_domain_gain_loss_files_base_dir.mkdir();
 588         }
 589         if ( domain_combinations ) {
 590             per_node_go_mapped_domain_gain_loss_files_base_dir = new File( per_node_go_mapped_domain_gain_loss_files_base_dir
 591                     + ForesterUtil.FILE_SEPARATOR + "DC" );
 592         }
 593         else {
 594             per_node_go_mapped_domain_gain_loss_files_base_dir = new File( per_node_go_mapped_domain_gain_loss_files_base_dir
 595                     + ForesterUtil.FILE_SEPARATOR + "DOMAINS" );
 596         }
 597         if ( !per_node_go_mapped_domain_gain_loss_files_base_dir.exists() ) {
 598             per_node_go_mapped_domain_gain_loss_files_base_dir.mkdir();
 599         }
 600         if ( state == GainLossStates.GAIN ) {
 601             per_node_go_mapped_domain_gain_loss_files_base_dir = new File( per_node_go_mapped_domain_gain_loss_files_base_dir
 602                     + ForesterUtil.FILE_SEPARATOR + "GAINS" );
 603         }
 604         else if ( state == GainLossStates.LOSS ) {
 605             per_node_go_mapped_domain_gain_loss_files_base_dir = new File( per_node_go_mapped_domain_gain_loss_files_base_dir
 606                     + ForesterUtil.FILE_SEPARATOR + "LOSSES" );
 607         }
 608         else {
 609             per_node_go_mapped_domain_gain_loss_files_base_dir = new File( per_node_go_mapped_domain_gain_loss_files_base_dir
 610                     + ForesterUtil.FILE_SEPARATOR + "PRESENT" );
 611         }
 612         if ( !per_node_go_mapped_domain_gain_loss_files_base_dir.exists() ) {
 613             per_node_go_mapped_domain_gain_loss_files_base_dir.mkdir();
 614         }
 615         return per_node_go_mapped_domain_gain_loss_files_base_dir;
 616     }
 617
 618     public static Map<DomainId, List<GoId>> createDomainIdToGoIdMap( final List<PfamToGoMapping> pfam_to_go_mappings ) {
 619         final Map<DomainId, List<GoId>> domain_id_to_go_ids_map = new HashMap<DomainId, List<GoId>>( pfam_to_go_mappings
 620                 .size() );
 621         for( final PfamToGoMapping pfam_to_go : pfam_to_go_mappings ) {
 622             if ( !domain_id_to_go_ids_map.containsKey( pfam_to_go.getKey() ) ) {
 623                 domain_id_to_go_ids_map.put( pfam_to_go.getKey(), new ArrayList<GoId>() );
 624             }
 625             domain_id_to_go_ids_map.get( pfam_to_go.getKey() ).add( pfam_to_go.getValue() );
 626         }
 627         return domain_id_to_go_ids_map;
 628     }
 629
 630     public static Map<DomainId, Set<String>> createDomainIdToSecondaryFeaturesMap( final File secondary_features_map_file )
 631             throws IOException {
 632         final BasicTable<String> primary_table = BasicTableParser.parse( secondary_features_map_file, "\t" );
 633         final Map<DomainId, Set<String>> map = new TreeMap<DomainId, Set<String>>();
 634         for( int r = 0; r < primary_table.getNumberOfRows(); ++r ) {
 635             final DomainId domain_id = new DomainId( primary_table.getValue( 0, r ) );
 636             if ( !map.containsKey( domain_id ) ) {
 637                 map.put( domain_id, new HashSet<String>() );
 638             }
 639             map.get( domain_id ).add( primary_table.getValue( 1, r ) );
 640         }
 641         return map;
 642     }
 643
 644     public static Phylogeny createNjTreeBasedOnMatrixToFile( final File nj_tree_outfile, final DistanceMatrix distance ) {
 645         checkForOutputFileWriteability( nj_tree_outfile );
 646         final NeighborJoining nj = NeighborJoining.createInstance();
 647         final Phylogeny phylogeny = nj.execute( ( BasicSymmetricalDistanceMatrix ) distance );
 648         phylogeny.setName( nj_tree_outfile.getName() );
 649         writePhylogenyToFile( phylogeny, nj_tree_outfile.toString() );
 650         return phylogeny;
 651     }
 652
 653     private static SortedSet<BinaryDomainCombination> createSetOfAllBinaryDomainCombinationsPerGenome( final GenomeWideCombinableDomains gwcd ) {
 654         final SortedMap<DomainId, CombinableDomains> cds = gwcd.getAllCombinableDomainsIds();
 655         final SortedSet<BinaryDomainCombination> binary_combinations = new TreeSet<BinaryDomainCombination>();
 656         for( final DomainId domain_id : cds.keySet() ) {
 657             final CombinableDomains cd = cds.get( domain_id );
 658             binary_combinations.addAll( cd.toBinaryDomainCombinations() );
 659         }
 660         return binary_combinations;
 661     }
 662
 663     public static void decoratePrintableDomainSimilarities( final SortedSet<DomainSimilarity> domain_similarities,
 664                                                             final Detailedness detailedness,
 665                                                             final GoAnnotationOutput go_annotation_output,
 666                                                             final Map<GoId, GoTerm> go_id_to_term_map,
 667                                                             final GoNameSpace go_namespace_limit ) {
 668         if ( ( go_namespace_limit != null ) && ( ( go_id_to_term_map == null ) || go_id_to_term_map.isEmpty() ) ) {
 669             throw new IllegalArgumentException( "attempt to use a GO namespace limit without a GO id to term map" );
 670         }
 671         for( final DomainSimilarity domain_similarity : domain_similarities ) {
 672             if ( domain_similarity instanceof PrintableDomainSimilarity ) {
 673                 final PrintableDomainSimilarity printable_domain_similarity = ( PrintableDomainSimilarity ) domain_similarity;
 674                 printable_domain_similarity.setDetailedness( detailedness );
 675                 printable_domain_similarity.setGoAnnotationOutput( go_annotation_output );
 676                 printable_domain_similarity.setGoIdToTermMap( go_id_to_term_map );
 677                 printable_domain_similarity.setGoNamespaceLimit( go_namespace_limit );
 678             }
 679         }
 680     }
 681
 682     public static void executeDomainLengthAnalysis( final String[][] input_file_properties,
 683                                                     final int number_of_genomes,
 684                                                     final DomainLengthsTable domain_lengths_table,
 685                                                     final File outfile ) throws IOException {
 686         final DecimalFormat df = new DecimalFormat( "#.00" );
 687         checkForOutputFileWriteability( outfile );
 688         final BufferedWriter out = new BufferedWriter( new FileWriter( outfile ) );
 689         out.write( "MEAN BASED STATISTICS PER SPECIES" );
 690         out.write( ForesterUtil.LINE_SEPARATOR );
 691         out.write( domain_lengths_table.createMeanBasedStatisticsPerSpeciesTable().toString() );
 692         out.write( ForesterUtil.LINE_SEPARATOR );
 693         out.write( ForesterUtil.LINE_SEPARATOR );
 694         final List<DomainLengths> domain_lengths_list = domain_lengths_table.getDomainLengthsList();
 695         out.write( "OUTLIER SPECIES PER DOMAIN (Z>=1.5)" );
 696         out.write( ForesterUtil.LINE_SEPARATOR );
 697         for( final DomainLengths domain_lengths : domain_lengths_list ) {
 698             final List<Species> species_list = domain_lengths.getMeanBasedOutlierSpecies( 1.5 );
 699             if ( species_list.size() > 0 ) {
 700                 out.write( domain_lengths.getDomainId() + "\t" );
 701                 for( final Species species : species_list ) {
 702                     out.write( species + "\t" );
 703                 }
 704                 out.write( ForesterUtil.LINE_SEPARATOR );
 705                 // DescriptiveStatistics stats_for_domain = domain_lengths
 706                 //         .calculateMeanBasedStatistics();
 707                 //AsciiHistogram histo = new AsciiHistogram( stats_for_domain );
 708                 //System.out.println( histo.toStringBuffer( 40, '=', 60, 4 ).toString() );
 709             }
 710         }
 711         out.write( ForesterUtil.LINE_SEPARATOR );
 712         out.write( ForesterUtil.LINE_SEPARATOR );
 713         out.write( "OUTLIER SPECIES (Z 1.0)" );
 714         out.write( ForesterUtil.LINE_SEPARATOR );
 715         final DescriptiveStatistics stats_for_all_species = domain_lengths_table
 716                 .calculateMeanBasedStatisticsForAllSpecies();
 717         out.write( stats_for_all_species.asSummary() );
 718         out.write( ForesterUtil.LINE_SEPARATOR );
 719         final AsciiHistogram histo = new AsciiHistogram( stats_for_all_species );
 720         out.write( histo.toStringBuffer( 40, '=', 60, 4 ).toString() );
 721         out.write( ForesterUtil.LINE_SEPARATOR );
 722         final double population_sd = stats_for_all_species.sampleStandardDeviation();
 723         final double population_mean = stats_for_all_species.arithmeticMean();
 724         for( final Species species : domain_lengths_table.getSpecies() ) {
 725             final double x = domain_lengths_table.calculateMeanBasedStatisticsForSpecies( species ).arithmeticMean();
 726             final double z = ( x - population_mean ) / population_sd;
 727             out.write( species + "\t" + z );
 728             out.write( ForesterUtil.LINE_SEPARATOR );
 729         }
 730         out.write( ForesterUtil.LINE_SEPARATOR );
 731         for( final Species species : domain_lengths_table.getSpecies() ) {
 732             final DescriptiveStatistics stats_for_species = domain_lengths_table
 733                     .calculateMeanBasedStatisticsForSpecies( species );
 734             final double x = stats_for_species.arithmeticMean();
 735             final double z = ( x - population_mean ) / population_sd;
 736             if ( ( z <= -1.0 ) || ( z >= 1.0 ) ) {
 737                 out.write( species + "\t" + df.format( z ) + "\t" + stats_for_species.asSummary() );
 738                 out.write( ForesterUtil.LINE_SEPARATOR );
 739             }
 740         }
 741         out.close();
 742         //        final List<HistogramData> histogram_datas = new ArrayList<HistogramData>();
 743         //        for( int i = 0; i < number_of_genomes; ++i ) {
 744         //            final Species species = new BasicSpecies( input_file_properties[ i ][ 0 ] );
 745         //            histogram_datas
 746         //                    .add( new HistogramData( species.toString(), domain_lengths_table
 747         //                            .calculateMeanBasedStatisticsForSpecies( species )
 748         //                            .getDataAsDoubleArray(), 5, 600, null, 60 ) );
 749         //        }
 750         //        final HistogramsFrame hf = new HistogramsFrame( histogram_datas );
 751         //        hf.setVisible( true );
 752         System.gc();
 753     }
 754
 755     /**
 756      *
 757      * @param all_binary_domains_combination_lost_fitch
 758      * @param consider_directedness_and_adjacency_for_bin_combinations
 759      * @param all_binary_domains_combination_gained if null ignored, otherwise this is to list all binary domain combinations
 760      * which were gained under unweighted (Fitch) parsimony.
 761      */
 762     public static void executeParsimonyAnalysis( final long random_number_seed_for_fitch_parsimony,
 763                                                  final boolean radomize_fitch_parsimony,
 764                                                  final String outfile_name,
 765                                                  final DomainParsimonyCalculator domain_parsimony,
 766                                                  final Phylogeny phylogeny,
 767                                                  final Map<DomainId, List<GoId>> domain_id_to_go_ids_map,
 768                                                  final Map<GoId, GoTerm> go_id_to_term_map,
 769                                                  final GoNameSpace go_namespace_limit,
 770                                                  final String parameters_str,
 771                                                  final Map<DomainId, Set<String>>[] domain_id_to_secondary_features_maps,
 772                                                  final SortedSet<DomainId> positive_filter,
 773                                                  final boolean output_binary_domain_combinations_for_graphs,
 774                                                  final List<BinaryDomainCombination> all_binary_domains_combination_gained_fitch,
 775                                                  final List<BinaryDomainCombination> all_binary_domains_combination_lost_fitch,
 776                                                  final BinaryDomainCombination.DomainCombinationType dc_type,
 777                                                  final Map<String, DescriptiveStatistics> protein_length_stats_by_dc,
 778                                                  final Map<String, DescriptiveStatistics> domain_number_stats_by_dc,
 779                                                  final Map<String, DescriptiveStatistics> domain_length_stats_by_domain ) {
 780         final String sep = ForesterUtil.LINE_SEPARATOR + "###################" + ForesterUtil.LINE_SEPARATOR;
 781         final String date_time = ForesterUtil.getCurrentDateTime();
 782         final SortedSet<String> all_pfams_encountered = new TreeSet<String>();
 783         final SortedSet<String> all_pfams_gained_as_domains = new TreeSet<String>();
 784         final SortedSet<String> all_pfams_lost_as_domains = new TreeSet<String>();
 785         final SortedSet<String> all_pfams_gained_as_dom_combinations = new TreeSet<String>();
 786         final SortedSet<String> all_pfams_lost_as_dom_combinations = new TreeSet<String>();
 787         writeToNexus( outfile_name, domain_parsimony, phylogeny );
 788         // DOLLO DOMAINS
 789         // -------------
 790         Phylogeny local_phylogeny_l = phylogeny.copy();
 791         if ( ( positive_filter != null ) && ( positive_filter.size() > 0 ) ) {
 792             domain_parsimony.executeDolloParsimonyOnDomainPresence( positive_filter );
 793         }
 794         else {
 795             domain_parsimony.executeDolloParsimonyOnDomainPresence();
 796         }
 797         SurfacingUtil.writeMatrixToFile( domain_parsimony.getGainLossMatrix(), outfile_name
 798                 + surfacing.PARSIMONY_OUTPUT_GL_SUFFIX_DOLLO_DOMAINS, Format.FORESTER );
 799         SurfacingUtil.writeMatrixToFile( domain_parsimony.getGainLossCountsMatrix(), outfile_name
 800                 + surfacing.PARSIMONY_OUTPUT_GL_COUNTS_SUFFIX_DOLLO_DOMAINS, Format.FORESTER );
 801         SurfacingUtil.writeBinaryStatesMatrixAsListToFile( domain_parsimony.getGainLossMatrix(),
 802                                                            CharacterStateMatrix.GainLossStates.GAIN,
 803                                                            outfile_name + surfacing.PARSIMONY_OUTPUT_DOLLO_GAINS_D,
 804                                                            sep,
 805                                                            ForesterUtil.LINE_SEPARATOR,
 806                                                            null );
 807         SurfacingUtil.writeBinaryStatesMatrixAsListToFile( domain_parsimony.getGainLossMatrix(),
 808                                                            CharacterStateMatrix.GainLossStates.LOSS,
 809                                                            outfile_name + surfacing.PARSIMONY_OUTPUT_DOLLO_LOSSES_D,
 810                                                            sep,
 811                                                            ForesterUtil.LINE_SEPARATOR,
 812                                                            null );
 813         SurfacingUtil.writeBinaryStatesMatrixAsListToFile( domain_parsimony.getGainLossMatrix(), null, outfile_name
 814                 + surfacing.PARSIMONY_OUTPUT_DOLLO_PRESENT_D, sep, ForesterUtil.LINE_SEPARATOR, null );
 815         //HTML:
 816         writeBinaryStatesMatrixToList( domain_id_to_go_ids_map,
 817                                        go_id_to_term_map,
 818                                        go_namespace_limit,
 819                                        false,
 820                                        domain_parsimony.getGainLossMatrix(),
 821                                        CharacterStateMatrix.GainLossStates.GAIN,
 822                                        outfile_name + surfacing.PARSIMONY_OUTPUT_DOLLO_GAINS_HTML_D,
 823                                        sep,
 824                                        ForesterUtil.LINE_SEPARATOR,
 825                                        "Dollo Parsimony | Gains | Domains",
 826                                        "+",
 827                                        domain_id_to_secondary_features_maps,
 828                                        all_pfams_encountered,
 829                                        all_pfams_gained_as_domains,
 830                                        "_dollo_gains_d" );
 831         writeBinaryStatesMatrixToList( domain_id_to_go_ids_map,
 832                                        go_id_to_term_map,
 833                                        go_namespace_limit,
 834                                        false,
 835                                        domain_parsimony.getGainLossMatrix(),
 836                                        CharacterStateMatrix.GainLossStates.LOSS,
 837                                        outfile_name + surfacing.PARSIMONY_OUTPUT_DOLLO_LOSSES_HTML_D,
 838                                        sep,
 839                                        ForesterUtil.LINE_SEPARATOR,
 840                                        "Dollo Parsimony | Losses | Domains",
 841                                        "-",
 842                                        domain_id_to_secondary_features_maps,
 843                                        all_pfams_encountered,
 844                                        all_pfams_lost_as_domains,
 845                                        "_dollo_losses_d" );
 846         writeBinaryStatesMatrixToList( domain_id_to_go_ids_map,
 847                                        go_id_to_term_map,
 848                                        go_namespace_limit,
 849                                        false,
 850                                        domain_parsimony.getGainLossMatrix(),
 851                                        null,
 852                                        outfile_name + surfacing.PARSIMONY_OUTPUT_DOLLO_PRESENT_HTML_D,
 853                                        sep,
 854                                        ForesterUtil.LINE_SEPARATOR,
 855                                        "Dollo Parsimony | Present | Domains",
 856                                        "",
 857                                        domain_id_to_secondary_features_maps,
 858                                        all_pfams_encountered,
 859                                        null,
 860                                        "_dollo_present_d" );
 861         preparePhylogeny( local_phylogeny_l,
 862                           domain_parsimony,
 863                           date_time,
 864                           "Dollo parsimony on domain presence/absence",
 865                           "dollo_on_domains_" + outfile_name,
 866                           parameters_str );
 867         SurfacingUtil.writePhylogenyToFile( local_phylogeny_l, outfile_name
 868                 + surfacing.DOMAINS_PARSIMONY_TREE_OUTPUT_SUFFIX_DOLLO );
 869         try {
 870             writeAllDomainsChangedOnAllSubtrees( local_phylogeny_l, true, outfile_name, "_dollo_all_gains_d" );
 871             writeAllDomainsChangedOnAllSubtrees( local_phylogeny_l, false, outfile_name, "_dollo_all_losses_d" );
 872         }
 873         catch ( final IOException e ) {
 874             e.printStackTrace();
 875             ForesterUtil.fatalError( surfacing.PRG_NAME, e.getLocalizedMessage() );
 876         }
 877         if ( domain_parsimony.calculateNumberOfBinaryDomainCombination() > 0 ) {
 878             // FITCH DOMAIN COMBINATIONS
 879             // -------------------------
 880             local_phylogeny_l = phylogeny.copy();
 881             String randomization = "no";
 882             if ( radomize_fitch_parsimony ) {
 883                 domain_parsimony.executeFitchParsimonyOnBinaryDomainCombintion( random_number_seed_for_fitch_parsimony );
 884                 randomization = "yes, seed = " + random_number_seed_for_fitch_parsimony;
 885             }
 886             else {
 887                 domain_parsimony.executeFitchParsimonyOnBinaryDomainCombintion( USE_LAST );
 888             }
 889             SurfacingUtil.writeMatrixToFile( domain_parsimony.getGainLossMatrix(), outfile_name
 890                     + surfacing.PARSIMONY_OUTPUT_GL_SUFFIX_FITCH_BINARY_COMBINATIONS, Format.FORESTER );
 891             SurfacingUtil.writeMatrixToFile( domain_parsimony.getGainLossCountsMatrix(), outfile_name
 892                     + surfacing.PARSIMONY_OUTPUT_GL_COUNTS_SUFFIX_FITCH_BINARY_COMBINATIONS, Format.FORESTER );
 893             SurfacingUtil
 894                     .writeBinaryStatesMatrixAsListToFile( domain_parsimony.getGainLossMatrix(),
 895                                                           CharacterStateMatrix.GainLossStates.GAIN,
 896                                                           outfile_name + surfacing.PARSIMONY_OUTPUT_FITCH_GAINS_BC,
 897                                                           sep,
 898                                                           ForesterUtil.LINE_SEPARATOR,
 899                                                           null );
 900             SurfacingUtil.writeBinaryStatesMatrixAsListToFile( domain_parsimony.getGainLossMatrix(),
 901                                                                CharacterStateMatrix.GainLossStates.LOSS,
 902                                                                outfile_name
 903                                                                        + surfacing.PARSIMONY_OUTPUT_FITCH_LOSSES_BC,
 904                                                                sep,
 905                                                                ForesterUtil.LINE_SEPARATOR,
 906                                                                null );
 907             SurfacingUtil.writeBinaryStatesMatrixAsListToFile( domain_parsimony.getGainLossMatrix(), null, outfile_name
 908                     + surfacing.PARSIMONY_OUTPUT_FITCH_PRESENT_BC, sep, ForesterUtil.LINE_SEPARATOR, null );
 909             if ( all_binary_domains_combination_gained_fitch != null ) {
 910                 collectChangedDomainCombinationsFromBinaryStatesMatrixAsListToFile( domain_parsimony.getGainLossMatrix(),
 911                                                                                     dc_type,
 912                                                                                     all_binary_domains_combination_gained_fitch,
 913                                                                                     true );
 914             }
 915             if ( all_binary_domains_combination_lost_fitch != null ) {
 916                 collectChangedDomainCombinationsFromBinaryStatesMatrixAsListToFile( domain_parsimony.getGainLossMatrix(),
 917                                                                                     dc_type,
 918                                                                                     all_binary_domains_combination_lost_fitch,
 919                                                                                     false );
 920             }
 921             if ( output_binary_domain_combinations_for_graphs ) {
 922                 SurfacingUtil
 923                         .writeBinaryStatesMatrixAsListToFileForBinaryCombinationsForGraphAnalysis( domain_parsimony
 924                                                                                                            .getGainLossMatrix(),
 925                                                                                                    null,
 926                                                                                                    outfile_name
 927                                                                                                            + surfacing.PARSIMONY_OUTPUT_FITCH_PRESENT_BC_OUTPUTFILE_SUFFIX_FOR_GRAPH_ANALYSIS,
 928                                                                                                    sep,
 929                                                                                                    ForesterUtil.LINE_SEPARATOR,
 930                                                                                                    BinaryDomainCombination.OutputFormat.DOT );
 931             }
 932             // HTML:
 933             writeBinaryStatesMatrixToList( domain_id_to_go_ids_map,
 934                                            go_id_to_term_map,
 935                                            go_namespace_limit,
 936                                            true,
 937                                            domain_parsimony.getGainLossMatrix(),
 938                                            CharacterStateMatrix.GainLossStates.GAIN,
 939                                            outfile_name + surfacing.PARSIMONY_OUTPUT_FITCH_GAINS_HTML_BC,
 940                                            sep,
 941                                            ForesterUtil.LINE_SEPARATOR,
 942                                            "Fitch Parsimony | Gains | Domain Combinations",
 943                                            "+",
 944                                            null,
 945                                            all_pfams_encountered,
 946                                            all_pfams_gained_as_dom_combinations,
 947                                            "_fitch_gains_dc" );
 948             writeBinaryStatesMatrixToList( domain_id_to_go_ids_map,
 949                                            go_id_to_term_map,
 950                                            go_namespace_limit,
 951                                            true,
 952                                            domain_parsimony.getGainLossMatrix(),
 953                                            CharacterStateMatrix.GainLossStates.LOSS,
 954                                            outfile_name + surfacing.PARSIMONY_OUTPUT_FITCH_LOSSES_HTML_BC,
 955                                            sep,
 956                                            ForesterUtil.LINE_SEPARATOR,
 957                                            "Fitch Parsimony | Losses | Domain Combinations",
 958                                            "-",
 959                                            null,
 960                                            all_pfams_encountered,
 961                                            all_pfams_lost_as_dom_combinations,
 962                                            "_fitch_losses_dc" );
 963             writeBinaryStatesMatrixToList( domain_id_to_go_ids_map,
 964                                            go_id_to_term_map,
 965                                            go_namespace_limit,
 966                                            true,
 967                                            domain_parsimony.getGainLossMatrix(),
 968                                            null,
 969                                            outfile_name + surfacing.PARSIMONY_OUTPUT_FITCH_PRESENT_HTML_BC,
 970                                            sep,
 971                                            ForesterUtil.LINE_SEPARATOR,
 972                                            "Fitch Parsimony | Present | Domain Combinations",
 973                                            "",
 974                                            null,
 975                                            all_pfams_encountered,
 976                                            null,
 977                                            "_fitch_present_dc" );
 978             writeAllEncounteredPfamsToFile( domain_id_to_go_ids_map,
 979                                             go_id_to_term_map,
 980                                             outfile_name,
 981                                             all_pfams_encountered );
 982             writePfamsToFile( outfile_name + surfacing.ALL_PFAMS_GAINED_AS_DOMAINS_SUFFIX, all_pfams_gained_as_domains );
 983             writePfamsToFile( outfile_name + surfacing.ALL_PFAMS_LOST_AS_DOMAINS_SUFFIX, all_pfams_lost_as_domains );
 984             writePfamsToFile( outfile_name + surfacing.ALL_PFAMS_GAINED_AS_DC_SUFFIX,
 985                               all_pfams_gained_as_dom_combinations );
 986             writePfamsToFile( outfile_name + surfacing.ALL_PFAMS_LOST_AS_DC_SUFFIX, all_pfams_lost_as_dom_combinations );
 987             preparePhylogeny( local_phylogeny_l,
 988                               domain_parsimony,
 989                               date_time,
 990                               "Fitch parsimony on binary domain combination presence/absence randomization: "
 991                                       + randomization,
 992                               "fitch_on_binary_domain_combinations_" + outfile_name,
 993                               parameters_str );
 994             SurfacingUtil.writePhylogenyToFile( local_phylogeny_l, outfile_name
 995                     + surfacing.BINARY_DOMAIN_COMBINATIONS_PARSIMONY_TREE_OUTPUT_SUFFIX_FITCH );
 996             calculateIndependentDomainCombinationGains( local_phylogeny_l,
 997                                                         outfile_name
 998                                                                 + surfacing.INDEPENDENT_DC_GAINS_FITCH_PARS_COUNTS_OUTPUT_SUFFIX,
 999                                                         outfile_name
1000                                                                 + surfacing.INDEPENDENT_DC_GAINS_FITCH_PARS_DC_OUTPUT_SUFFIX,
1001                                                         outfile_name
1002                                                                 + surfacing.INDEPENDENT_DC_GAINS_FITCH_PARS_DC_FOR_GO_MAPPING_OUTPUT_SUFFIX,
1003                                                         outfile_name
1004                                                                 + surfacing.INDEPENDENT_DC_GAINS_FITCH_PARS_DC_FOR_GO_MAPPING_OUTPUT_UNIQUE_SUFFIX,
1005                                                         outfile_name + "_indep_dc_gains_fitch_lca_ranks.txt",
1006                                                         outfile_name + "_indep_dc_gains_fitch_lca_taxonomies.txt",
1007                                                         outfile_name + "_indep_dc_gains_fitch_protein_statistics.txt",
1008                                                         protein_length_stats_by_dc,
1009                                                         domain_number_stats_by_dc,
1010                                                         domain_length_stats_by_domain );
1011         }
1012     }
1013
1014     public static void executeParsimonyAnalysisForSecondaryFeatures( final String outfile_name,
1015                                                                      final DomainParsimonyCalculator secondary_features_parsimony,
1016                                                                      final Phylogeny phylogeny,
1017                                                                      final String parameters_str,
1018                                                                      final Map<Species, MappingResults> mapping_results_map ) {
1019         final String sep = ForesterUtil.LINE_SEPARATOR + "###################" + ForesterUtil.LINE_SEPARATOR;
1020         final String date_time = ForesterUtil.getCurrentDateTime();
1021         System.out.println();
1022         writeToNexus( outfile_name + surfacing.NEXUS_SECONDARY_FEATURES,
1023                       secondary_features_parsimony.createMatrixOfSecondaryFeaturePresenceOrAbsence( null ),
1024                       phylogeny );
1025         Phylogeny local_phylogeny_copy = phylogeny.copy();
1026         secondary_features_parsimony.executeDolloParsimonyOnSecondaryFeatures( mapping_results_map );
1027         SurfacingUtil.writeMatrixToFile( secondary_features_parsimony.getGainLossMatrix(), outfile_name
1028                 + surfacing.PARSIMONY_OUTPUT_GL_SUFFIX_DOLLO_SECONDARY_FEATURES, Format.FORESTER );
1029         SurfacingUtil.writeMatrixToFile( secondary_features_parsimony.getGainLossCountsMatrix(), outfile_name
1030                 + surfacing.PARSIMONY_OUTPUT_GL_COUNTS_SUFFIX_DOLLO_SECONDARY_FEATURES, Format.FORESTER );
1031         SurfacingUtil
1032                 .writeBinaryStatesMatrixAsListToFile( secondary_features_parsimony.getGainLossMatrix(),
1033                                                       CharacterStateMatrix.GainLossStates.GAIN,
1034                                                       outfile_name
1035                                                               + surfacing.PARSIMONY_OUTPUT_DOLLO_GAINS_SECONDARY_FEATURES,
1036                                                       sep,
1037                                                       ForesterUtil.LINE_SEPARATOR,
1038                                                       null );
1039         SurfacingUtil
1040                 .writeBinaryStatesMatrixAsListToFile( secondary_features_parsimony.getGainLossMatrix(),
1041                                                       CharacterStateMatrix.GainLossStates.LOSS,
1042                                                       outfile_name
1043                                                               + surfacing.PARSIMONY_OUTPUT_DOLLO_LOSSES_SECONDARY_FEATURES,
1044                                                       sep,
1045                                                       ForesterUtil.LINE_SEPARATOR,
1046                                                       null );
1047         SurfacingUtil
1048                 .writeBinaryStatesMatrixAsListToFile( secondary_features_parsimony.getGainLossMatrix(),
1049                                                       null,
1050                                                       outfile_name
1051                                                               + surfacing.PARSIMONY_OUTPUT_DOLLO_PRESENT_SECONDARY_FEATURES,
1052                                                       sep,
1053                                                       ForesterUtil.LINE_SEPARATOR,
1054                                                       null );
1055         preparePhylogeny( local_phylogeny_copy,
1056                           secondary_features_parsimony,
1057                           date_time,
1058                           "Dollo parsimony on secondary feature presence/absence",
1059                           "dollo_on_secondary_features_" + outfile_name,
1060                           parameters_str );
1061         SurfacingUtil.writePhylogenyToFile( local_phylogeny_copy, outfile_name
1062                 + surfacing.SECONDARY_FEATURES_PARSIMONY_TREE_OUTPUT_SUFFIX_DOLLO );
1063         // FITCH DOMAIN COMBINATIONS
1064         // -------------------------
1065         local_phylogeny_copy = phylogeny.copy();
1066         final String randomization = "no";
1067         secondary_features_parsimony.executeFitchParsimonyOnBinaryDomainCombintionOnSecondaryFeatures( USE_LAST );
1068         preparePhylogeny( local_phylogeny_copy,
1069                           secondary_features_parsimony,
1070                           date_time,
1071                           "Fitch parsimony on secondary binary domain combination presence/absence randomization: "
1072                                   + randomization,
1073                           "fitch_on_binary_domain_combinations_" + outfile_name,
1074                           parameters_str );
1075         SurfacingUtil.writePhylogenyToFile( local_phylogeny_copy, outfile_name
1076                 + surfacing.BINARY_DOMAIN_COMBINATIONS_PARSIMONY_TREE_OUTPUT_SUFFIX_FITCH_MAPPED );
1077         calculateIndependentDomainCombinationGains( local_phylogeny_copy, outfile_name
1078                 + surfacing.INDEPENDENT_DC_GAINS_FITCH_PARS_COUNTS_MAPPED_OUTPUT_SUFFIX, outfile_name
1079                 + surfacing.INDEPENDENT_DC_GAINS_FITCH_PARS_DC_MAPPED_OUTPUT_SUFFIX, outfile_name
1080                 + surfacing.INDEPENDENT_DC_GAINS_FITCH_PARS_DC_FOR_GO_MAPPING_MAPPED_OUTPUT_SUFFIX, outfile_name
1081                 + surfacing.INDEPENDENT_DC_GAINS_FITCH_PARS_DC_FOR_GO_MAPPING_MAPPED_OUTPUT_UNIQUE_SUFFIX, outfile_name
1082                 + "_MAPPED_indep_dc_gains_fitch_lca_ranks.txt", outfile_name
1083                 + "_MAPPED_indep_dc_gains_fitch_lca_taxonomies.txt", null, null, null, null );
1084     }
1085
1086     public static void doit( final List<Protein> proteins,
1087                              final List<DomainId> query_domain_ids_nc_order,
1088                              final Writer out,
1089                              final String separator,
1090                              final String limit_to_species,
1091                              final Map<String, List<Integer>> average_protein_lengths_by_dc ) throws IOException {
1092         for( final Protein protein : proteins ) {
1093             if ( ForesterUtil.isEmpty( limit_to_species )
1094                     || protein.getSpecies().getSpeciesId().equalsIgnoreCase( limit_to_species ) ) {
1095                 if ( protein.contains( query_domain_ids_nc_order, true ) ) {
1096                     out.write( protein.getSpecies().getSpeciesId() );
1097                     out.write( separator );
1098                     out.write( protein.getProteinId().getId() );
1099                     out.write( separator );
1100                     out.write( "[" );
1101                     final Set<DomainId> visited_domain_ids = new HashSet<DomainId>();
1102                     boolean first = true;
1103                     for( final Domain domain : protein.getProteinDomains() ) {
1104                         if ( !visited_domain_ids.contains( domain.getDomainId() ) ) {
1105                             visited_domain_ids.add( domain.getDomainId() );
1106                             if ( first ) {
1107                                 first = false;
1108                             }
1109                             else {
1110                                 out.write( " " );
1111                             }
1112                             out.write( domain.getDomainId().getId() );
1113                             out.write( " {" );
1114                             out.write( "" + domain.getTotalCount() );
1115                             out.write( "}" );
1116                         }
1117                     }
1118                     out.write( "]" );
1119                     out.write( separator );
1120                     if ( !( ForesterUtil.isEmpty( protein.getDescription() ) || protein.getDescription()
1121                             .equals( SurfacingConstants.NONE ) ) ) {
1122                         out.write( protein.getDescription() );
1123                     }
1124                     out.write( separator );
1125                     if ( !( ForesterUtil.isEmpty( protein.getAccession() ) || protein.getAccession()
1126                             .equals( SurfacingConstants.NONE ) ) ) {
1127                         out.write( protein.getAccession() );
1128                     }
1129                     out.write( SurfacingConstants.NL );
1130                 }
1131             }
1132         }
1133         out.flush();
1134     }
1135
1136     public static void extractProteinNames( final List<Protein> proteins,
1137                                             final List<DomainId> query_domain_ids_nc_order,
1138                                             final Writer out,
1139                                             final String separator,
1140                                             final String limit_to_species ) throws IOException {
1141         for( final Protein protein : proteins ) {
1142             if ( ForesterUtil.isEmpty( limit_to_species )
1143                     || protein.getSpecies().getSpeciesId().equalsIgnoreCase( limit_to_species ) ) {
1144                 if ( protein.contains( query_domain_ids_nc_order, true ) ) {
1145                     out.write( protein.getSpecies().getSpeciesId() );
1146                     out.write( separator );
1147                     out.write( protein.getProteinId().getId() );
1148                     out.write( separator );
1149                     out.write( "[" );
1150                     final Set<DomainId> visited_domain_ids = new HashSet<DomainId>();
1151                     boolean first = true;
1152                     for( final Domain domain : protein.getProteinDomains() ) {
1153                         if ( !visited_domain_ids.contains( domain.getDomainId() ) ) {
1154                             visited_domain_ids.add( domain.getDomainId() );
1155                             if ( first ) {
1156                                 first = false;
1157                             }
1158                             else {
1159                                 out.write( " " );
1160                             }
1161                             out.write( domain.getDomainId().getId() );
1162                             out.write( " {" );
1163                             out.write( "" + domain.getTotalCount() );
1164                             out.write( "}" );
1165                         }
1166                     }
1167                     out.write( "]" );
1168                     out.write( separator );
1169                     if ( !( ForesterUtil.isEmpty( protein.getDescription() ) || protein.getDescription()
1170                             .equals( SurfacingConstants.NONE ) ) ) {
1171                         out.write( protein.getDescription() );
1172                     }
1173                     out.write( separator );
1174                     if ( !( ForesterUtil.isEmpty( protein.getAccession() ) || protein.getAccession()
1175                             .equals( SurfacingConstants.NONE ) ) ) {
1176                         out.write( protein.getAccession() );
1177                     }
1178                     out.write( SurfacingConstants.NL );
1179                 }
1180             }
1181         }
1182         out.flush();
1183     }
1184
1185     public static void extractProteinNames( final SortedMap<Species, List<Protein>> protein_lists_per_species,
1186                                             final DomainId domain_id,
1187                                             final Writer out,
1188                                             final String separator,
1189                                             final String limit_to_species,
1190                                             final double domain_e_cutoff ) throws IOException {
1191         System.out.println( "Per domain E-value: " + domain_e_cutoff );
1192
1193         for( final Species species : protein_lists_per_species.keySet() ) {
1194             System.out.println( species + ":" );
1195             for( final Protein protein : protein_lists_per_species.get( species ) ) {
1196                 if ( ForesterUtil.isEmpty( limit_to_species )
1197                         || protein.getSpecies().getSpeciesId().equalsIgnoreCase( limit_to_species ) ) {
1198                     final List<Domain> domains = protein.getProteinDomains( domain_id );
1199
1200                     if ( domains.size() > 0 ) {
1201                         out.write( protein.getSpecies().getSpeciesId() );
1202                         out.write( separator );
1203                         out.write( protein.getProteinId().getId() );
1204                         out.write( separator );
1205                         out.write( domain_id.toString() );
1206                         out.write( separator );
1207                         int prev_to = -1;
1208
1209                         for( final Domain domain : domains ) {
1210
1211                             if ( domain_e_cutoff < 0 || domain.getPerDomainEvalue() <= domain_e_cutoff ) {
1212                                  out.write( "/" );
1213                                  out.write( domain.getFrom() + "-" + domain.getTo() );
1214                                  if ( prev_to >= 0) {
1215                                      final int l = domain.getFrom() - prev_to;
1216                                      System.out.println( l );
1217                                  }
1218                                  prev_to = domain.getTo();
1219                             }
1220                         }
1221
1222                         out.write( "/" );
1223                         out.write( separator );
1224
1225
1226                         final List<Domain> domain_list = new ArrayList<Domain>();
1227
1228                         for( final Domain domain : protein.getProteinDomains() ) {
1229                             if ( domain_e_cutoff < 0 || domain.getPerDomainEvalue() <= domain_e_cutoff ) {
1230                                 domain_list.add( domain );
1231                             }
1232                         }
1233
1234                         Domain domain_ary[] = new Domain[ domain_list.size() ];
1235
1236                         for( int i = 0; i < domain_list.size(); ++i ) {
1237                             domain_ary[ i ] = domain_list.get( i );
1238                         }
1239
1240                         Arrays.sort( domain_ary, new DomainComparator( true ) );
1241
1242                         out.write( "{" );
1243                         boolean first = true;
1244
1245                         for( final Domain domain : domain_ary ) {
1246                             if ( first ) {
1247                                 first = false;
1248                             }
1249                             else {
1250                                 out.write( "," );
1251                             }
1252                             out.write( domain.getDomainId().toString() );
1253                             out.write( ":" + domain.getFrom() +  "-" + domain.getTo() );
1254                             out.write( ":" + domain.getPerDomainEvalue() );
1255                         }
1256                         out.write( "}" );
1257                         if ( !( ForesterUtil.isEmpty( protein.getDescription() ) || protein.getDescription()
1258                                 .equals( SurfacingConstants.NONE ) ) ) {
1259                             out.write( protein.getDescription() );
1260                         }
1261                         out.write( separator );
1262                         if ( !( ForesterUtil.isEmpty( protein.getAccession() ) || protein.getAccession()
1263                                 .equals( SurfacingConstants.NONE ) ) ) {
1264                             out.write( protein.getAccession() );
1265                         }
1266                         out.write( SurfacingConstants.NL );
1267                     }
1268
1269                 }
1270             }
1271         }
1272         out.flush();
1273     }
1274
1275     public static SortedSet<DomainId> getAllDomainIds( final List<GenomeWideCombinableDomains> gwcd_list ) {
1276         final SortedSet<DomainId> all_domains_ids = new TreeSet<DomainId>();
1277         for( final GenomeWideCombinableDomains gwcd : gwcd_list ) {
1278             final Set<DomainId> all_domains = gwcd.getAllDomainIds();
1279             //    for( final Domain domain : all_domains ) {
1280             all_domains_ids.addAll( all_domains );
1281             //    }
1282         }
1283         return all_domains_ids;
1284     }
1285
1286     public static SortedMap<String, Integer> getDomainCounts( final List<Protein> protein_domain_collections ) {
1287         final SortedMap<String, Integer> map = new TreeMap<String, Integer>();
1288         for( final Protein protein_domain_collection : protein_domain_collections ) {
1289             for( final Object name : protein_domain_collection.getProteinDomains() ) {
1290                 final BasicDomain protein_domain = ( BasicDomain ) name;
1291                 final String id = protein_domain.getDomainId().getId();
1292                 if ( map.containsKey( id ) ) {
1293                     map.put( id, map.get( id ) + 1 );
1294                 }
1295                 else {
1296                     map.put( id, 1 );
1297                 }
1298             }
1299         }
1300         return map;
1301     }
1302
1303     public static int getNumberOfNodesLackingName( final Phylogeny p, final StringBuilder names ) {
1304         final PhylogenyNodeIterator it = p.iteratorPostorder();
1305         int c = 0;
1306         while ( it.hasNext() ) {
1307             final PhylogenyNode n = it.next();
1308             if ( ForesterUtil.isEmpty( n.getName() )
1309                     && ( !n.getNodeData().isHasTaxonomy() || ForesterUtil.isEmpty( n.getNodeData().getTaxonomy()
1310                             .getScientificName() ) )
1311                     && ( !n.getNodeData().isHasTaxonomy() || ForesterUtil.isEmpty( n.getNodeData().getTaxonomy()
1312                             .getCommonName() ) ) ) {
1313                 if ( n.getParent() != null ) {
1314                     names.append( " " );
1315                     names.append( n.getParent().getName() );
1316                 }
1317                 final List l = n.getAllExternalDescendants();
1318                 for( final Object object : l ) {
1319                     System.out.println( l.toString() );
1320                 }
1321                 ++c;
1322             }
1323         }
1324         return c;
1325     }
1326
1327     /**
1328      * Returns true is Domain domain falls in an uninterrupted stretch of
1329      * covered positions.
1330      *
1331      * @param domain
1332      * @param covered_positions
1333      * @return
1334      */
1335     public static boolean isEngulfed( final Domain domain, final List<Boolean> covered_positions ) {
1336         for( int i = domain.getFrom(); i <= domain.getTo(); ++i ) {
1337             if ( ( i >= covered_positions.size() ) || ( covered_positions.get( i ) != true ) ) {
1338                 return false;
1339             }
1340         }
1341         return true;
1342     }
1343
1344     public static void preparePhylogeny( final Phylogeny p,
1345                                          final DomainParsimonyCalculator domain_parsimony,
1346                                          final String date_time,
1347                                          final String method,
1348                                          final String name,
1349                                          final String parameters_str ) {
1350         domain_parsimony.decoratePhylogenyWithDomains( p );
1351         final StringBuilder desc = new StringBuilder();
1352         desc.append( "[Method: " + method + "] [Date: " + date_time + "] " );
1353         desc.append( "[Cost: " + domain_parsimony.getCost() + "] " );
1354         desc.append( "[Gains: " + domain_parsimony.getTotalGains() + "] " );
1355         desc.append( "[Losses: " + domain_parsimony.getTotalLosses() + "] " );
1356         desc.append( "[Unchanged: " + domain_parsimony.getTotalUnchanged() + "] " );
1357         desc.append( "[Parameters: " + parameters_str + "]" );
1358         p.setName( name );
1359         p.setDescription( desc.toString() );
1360         p.setConfidence( new Confidence( domain_parsimony.getCost(), "parsimony" ) );
1361         p.setRerootable( false );
1362         p.setRooted( true );
1363     }
1364
1365     /*
1366      * species | protein id | n-terminal domain | c-terminal domain | n-terminal domain per domain E-value | c-terminal domain per domain E-value
1367      *
1368      *
1369      */
1370     static public StringBuffer proteinToDomainCombinations( final Protein protein,
1371                                                             final String protein_id,
1372                                                             final String separator ) {
1373         final StringBuffer sb = new StringBuffer();
1374         if ( protein.getSpecies() == null ) {
1375             throw new IllegalArgumentException( "species must not be null" );
1376         }
1377         if ( ForesterUtil.isEmpty( protein.getSpecies().getSpeciesId() ) ) {
1378             throw new IllegalArgumentException( "species id must not be empty" );
1379         }
1380         final List<Domain> domains = protein.getProteinDomains();
1381         if ( domains.size() > 1 ) {
1382             final Map<String, Integer> counts = new HashMap<String, Integer>();
1383             for( final Domain domain : domains ) {
1384                 final String id = domain.getDomainId().getId();
1385                 if ( counts.containsKey( id ) ) {
1386                     counts.put( id, counts.get( id ) + 1 );
1387                 }
1388                 else {
1389                     counts.put( id, 1 );
1390                 }
1391             }
1392             final Set<String> dcs = new HashSet<String>();
1393             for( int i = 1; i < domains.size(); ++i ) {
1394                 for( int j = 0; j < i; ++j ) {
1395                     Domain domain_n = domains.get( i );
1396                     Domain domain_c = domains.get( j );
1397                     if ( domain_n.getFrom() > domain_c.getFrom() ) {
1398                         domain_n = domains.get( j );
1399                         domain_c = domains.get( i );
1400                     }
1401                     final String dc = domain_n.getDomainId().getId() + domain_c.getDomainId().getId();
1402                     if ( !dcs.contains( dc ) ) {
1403                         dcs.add( dc );
1404                         sb.append( protein.getSpecies() );
1405                         sb.append( separator );
1406                         sb.append( protein_id );
1407                         sb.append( separator );
1408                         sb.append( domain_n.getDomainId().getId() );
1409                         sb.append( separator );
1410                         sb.append( domain_c.getDomainId().getId() );
1411                         sb.append( separator );
1412                         sb.append( domain_n.getPerDomainEvalue() );
1413                         sb.append( separator );
1414                         sb.append( domain_c.getPerDomainEvalue() );
1415                         sb.append( separator );
1416                         sb.append( counts.get( domain_n.getDomainId().getId() ) );
1417                         sb.append( separator );
1418                         sb.append( counts.get( domain_c.getDomainId().getId() ) );
1419                         sb.append( ForesterUtil.LINE_SEPARATOR );
1420                     }
1421                 }
1422             }
1423         }
1424         else if ( domains.size() == 1 ) {
1425             sb.append( protein.getSpecies() );
1426             sb.append( separator );
1427             sb.append( protein_id );
1428             sb.append( separator );
1429             sb.append( domains.get( 0 ).getDomainId().getId() );
1430             sb.append( separator );
1431             sb.append( separator );
1432             sb.append( domains.get( 0 ).getPerDomainEvalue() );
1433             sb.append( separator );
1434             sb.append( separator );
1435             sb.append( 1 );
1436             sb.append( separator );
1437             sb.append( ForesterUtil.LINE_SEPARATOR );
1438         }
1439         else {
1440             sb.append( protein.getSpecies() );
1441             sb.append( separator );
1442             sb.append( protein_id );
1443             sb.append( separator );
1444             sb.append( separator );
1445             sb.append( separator );
1446             sb.append( separator );
1447             sb.append( separator );
1448             sb.append( separator );
1449             sb.append( ForesterUtil.LINE_SEPARATOR );
1450         }
1451         return sb;
1452     }
1453
1454     /**
1455      *
1456      * Example regarding engulfment: ------------0.1 ----------0.2 --0.3 =>
1457      * domain with 0.3 is ignored
1458      *
1459      * -----------0.1 ----------0.2 --0.3 => domain with 0.3 is ignored
1460      *
1461      *
1462      * ------------0.1 ----------0.3 --0.2 => domains with 0.3 and 0.2 are _not_
1463      * ignored
1464      *
1465      * @param max_allowed_overlap
1466      *            maximal allowed overlap (inclusive) to be still considered not
1467      *            overlapping (zero or negative value to allow any overlap)
1468      * @param remove_engulfed_domains
1469      *            to remove domains which are completely engulfed by coverage of
1470      *            domains with better support
1471      * @param protein
1472      * @return
1473      */
1474     public static Protein removeOverlappingDomains( final int max_allowed_overlap,
1475                                                     final boolean remove_engulfed_domains,
1476                                                     final Protein protein ) {
1477         final Protein pruned_protein = new BasicProtein( protein.getProteinId().getId(), protein.getSpecies()
1478                 .getSpeciesId(), protein.getLength() );
1479         final List<Domain> sorted = SurfacingUtil.sortDomainsWithAscendingConfidenceValues( protein );
1480         final List<Boolean> covered_positions = new ArrayList<Boolean>();
1481         for( final Domain domain : sorted ) {
1482             if ( ( ( max_allowed_overlap < 0 ) || ( SurfacingUtil.calculateOverlap( domain, covered_positions ) <= max_allowed_overlap ) )
1483                     && ( !remove_engulfed_domains || !isEngulfed( domain, covered_positions ) ) ) {
1484                 final int covered_positions_size = covered_positions.size();
1485                 for( int i = covered_positions_size; i < domain.getFrom(); ++i ) {
1486                     covered_positions.add( false );
1487                 }
1488                 final int new_covered_positions_size = covered_positions.size();
1489                 for( int i = domain.getFrom(); i <= domain.getTo(); ++i ) {
1490                     if ( i < new_covered_positions_size ) {
1491                         covered_positions.set( i, true );
1492                     }
1493                     else {
1494                         covered_positions.add( true );
1495                     }
1496                 }
1497                 pruned_protein.addProteinDomain( domain );
1498             }
1499         }
1500         return pruned_protein;
1501     }
1502
1503     public static List<Domain> sortDomainsWithAscendingConfidenceValues( final Protein protein ) {
1504         final List<Domain> domains = new ArrayList<Domain>();
1505         for( final Domain d : protein.getProteinDomains() ) {
1506             domains.add( d );
1507         }
1508         Collections.sort( domains, SurfacingUtil.ASCENDING_CONFIDENCE_VALUE_ORDER );
1509         return domains;
1510     }
1511
1512     private static List<String> splitDomainCombination( final String dc ) {
1513         final String[] s = dc.split( "=" );
1514         if ( s.length != 2 ) {
1515             ForesterUtil.printErrorMessage( surfacing.PRG_NAME, "Stringyfied domain combination has illegal format: "
1516                     + dc );
1517             System.exit( -1 );
1518         }
1519         final List<String> l = new ArrayList<String>( 2 );
1520         l.add( s[ 0 ] );
1521         l.add( s[ 1 ] );
1522         return l;
1523     }
1524
1525     public static void writeAllDomainsChangedOnAllSubtrees( final Phylogeny p,
1526                                                             final boolean get_gains,
1527                                                             final String outdir,
1528                                                             final String suffix_for_filename ) throws IOException {
1529         CharacterStateMatrix.GainLossStates state = CharacterStateMatrix.GainLossStates.GAIN;
1530         if ( !get_gains ) {
1531             state = CharacterStateMatrix.GainLossStates.LOSS;
1532         }
1533         final File base_dir = createBaseDirForPerNodeDomainFiles( surfacing.BASE_DIRECTORY_PER_SUBTREE_DOMAIN_GAIN_LOSS_FILES,
1534                                                                   false,
1535                                                                   state,
1536                                                                   outdir );
1537         for( final PhylogenyNodeIterator it = p.iteratorPostorder(); it.hasNext(); ) {
1538             final PhylogenyNode node = it.next();
1539             if ( !node.isExternal() ) {
1540                 final SortedSet<String> domains = collectAllDomainsChangedOnSubtree( node, get_gains );
1541                 if ( domains.size() > 0 ) {
1542                     final Writer writer = ForesterUtil.createBufferedWriter( base_dir + ForesterUtil.FILE_SEPARATOR
1543                             + node.getName() + suffix_for_filename );
1544                     for( final String domain : domains ) {
1545                         writer.write( domain );
1546                         writer.write( ForesterUtil.LINE_SEPARATOR );
1547                     }
1548                     writer.close();
1549                 }
1550             }
1551         }
1552     }
1553
1554     private static void writeAllEncounteredPfamsToFile( final Map<DomainId, List<GoId>> domain_id_to_go_ids_map,
1555                                                         final Map<GoId, GoTerm> go_id_to_term_map,
1556                                                         final String outfile_name,
1557                                                         final SortedSet<String> all_pfams_encountered ) {
1558         final File all_pfams_encountered_file = new File( outfile_name + surfacing.ALL_PFAMS_ENCOUNTERED_SUFFIX );
1559         final File all_pfams_encountered_with_go_annotation_file = new File( outfile_name
1560                 + surfacing.ALL_PFAMS_ENCOUNTERED_WITH_GO_ANNOTATION_SUFFIX );
1561         final File encountered_pfams_summary_file = new File( outfile_name + surfacing.ENCOUNTERED_PFAMS_SUMMARY_SUFFIX );
1562         int biological_process_counter = 0;
1563         int cellular_component_counter = 0;
1564         int molecular_function_counter = 0;
1565         int pfams_with_mappings_counter = 0;
1566         int pfams_without_mappings_counter = 0;
1567         int pfams_without_mappings_to_bp_or_mf_counter = 0;
1568         int pfams_with_mappings_to_bp_or_mf_counter = 0;
1569         try {
1570             final Writer all_pfams_encountered_writer = new BufferedWriter( new FileWriter( all_pfams_encountered_file ) );
1571             final Writer all_pfams_encountered_with_go_annotation_writer = new BufferedWriter( new FileWriter( all_pfams_encountered_with_go_annotation_file ) );
1572             final Writer summary_writer = new BufferedWriter( new FileWriter( encountered_pfams_summary_file ) );
1573             summary_writer.write( "# Pfam to GO mapping summary" );
1574             summary_writer.write( ForesterUtil.LINE_SEPARATOR );
1575             summary_writer.write( "# Actual summary is at the end of this file." );
1576             summary_writer.write( ForesterUtil.LINE_SEPARATOR );
1577             summary_writer.write( "# Encountered Pfams without a GO mapping:" );
1578             summary_writer.write( ForesterUtil.LINE_SEPARATOR );
1579             for( final String pfam : all_pfams_encountered ) {
1580                 all_pfams_encountered_writer.write( pfam );
1581                 all_pfams_encountered_writer.write( ForesterUtil.LINE_SEPARATOR );
1582                 final DomainId domain_id = new DomainId( pfam );
1583                 if ( domain_id_to_go_ids_map.containsKey( domain_id ) ) {
1584                     ++pfams_with_mappings_counter;
1585                     all_pfams_encountered_with_go_annotation_writer.write( pfam );
1586                     all_pfams_encountered_with_go_annotation_writer.write( ForesterUtil.LINE_SEPARATOR );
1587                     final List<GoId> go_ids = domain_id_to_go_ids_map.get( domain_id );
1588                     boolean maps_to_bp = false;
1589                     boolean maps_to_cc = false;
1590                     boolean maps_to_mf = false;
1591                     for( final GoId go_id : go_ids ) {
1592                         final GoTerm go_term = go_id_to_term_map.get( go_id );
1593                         if ( go_term.getGoNameSpace().isBiologicalProcess() ) {
1594                             maps_to_bp = true;
1595                         }
1596                         else if ( go_term.getGoNameSpace().isCellularComponent() ) {
1597                             maps_to_cc = true;
1598                         }
1599                         else if ( go_term.getGoNameSpace().isMolecularFunction() ) {
1600                             maps_to_mf = true;
1601                         }
1602                     }
1603                     if ( maps_to_bp ) {
1604                         ++biological_process_counter;
1605                     }
1606                     if ( maps_to_cc ) {
1607                         ++cellular_component_counter;
1608                     }
1609                     if ( maps_to_mf ) {
1610                         ++molecular_function_counter;
1611                     }
1612                     if ( maps_to_bp || maps_to_mf ) {
1613                         ++pfams_with_mappings_to_bp_or_mf_counter;
1614                     }
1615                     else {
1616                         ++pfams_without_mappings_to_bp_or_mf_counter;
1617                     }
1618                 }
1619                 else {
1620                     ++pfams_without_mappings_to_bp_or_mf_counter;
1621                     ++pfams_without_mappings_counter;
1622                     summary_writer.write( pfam );
1623                     summary_writer.write( ForesterUtil.LINE_SEPARATOR );
1624                 }
1625             }
1626             all_pfams_encountered_writer.close();
1627             all_pfams_encountered_with_go_annotation_writer.close();
1628             ForesterUtil.programMessage( surfacing.PRG_NAME, "Wrote all [" + all_pfams_encountered.size()
1629                     + "] encountered Pfams to: \"" + all_pfams_encountered_file + "\"" );
1630             ForesterUtil.programMessage( surfacing.PRG_NAME, "Wrote all [" + pfams_with_mappings_counter
1631                     + "] encountered Pfams with GO mappings to: \"" + all_pfams_encountered_with_go_annotation_file
1632                     + "\"" );
1633             ForesterUtil.programMessage( surfacing.PRG_NAME, "Wrote summary (including all ["
1634                     + pfams_without_mappings_counter + "] encountered Pfams without GO mappings) to: \""
1635                     + encountered_pfams_summary_file + "\"" );
1636             ForesterUtil.programMessage( surfacing.PRG_NAME, "Sum of Pfams encountered                : "
1637                     + all_pfams_encountered.size() );
1638             ForesterUtil.programMessage( surfacing.PRG_NAME, "Pfams without a mapping                 : "
1639                     + pfams_without_mappings_counter + " ["
1640                     + ( 100 * pfams_without_mappings_counter / all_pfams_encountered.size() ) + "%]" );
1641             ForesterUtil.programMessage( surfacing.PRG_NAME, "Pfams without mapping to proc. or func. : "
1642                     + pfams_without_mappings_to_bp_or_mf_counter + " ["
1643                     + ( 100 * pfams_without_mappings_to_bp_or_mf_counter / all_pfams_encountered.size() ) + "%]" );
1644             ForesterUtil.programMessage( surfacing.PRG_NAME,
1645                                          "Pfams with a mapping                    : " + pfams_with_mappings_counter
1646                                                  + " ["
1647                                                  + ( 100 * pfams_with_mappings_counter / all_pfams_encountered.size() )
1648                                                  + "%]" );
1649             ForesterUtil.programMessage( surfacing.PRG_NAME, "Pfams with a mapping to proc. or func.  : "
1650                     + pfams_with_mappings_to_bp_or_mf_counter + " ["
1651                     + ( 100 * pfams_with_mappings_to_bp_or_mf_counter / all_pfams_encountered.size() ) + "%]" );
1652             ForesterUtil.programMessage( surfacing.PRG_NAME,
1653                                          "Pfams with mapping to biological process: " + biological_process_counter
1654                                                  + " ["
1655                                                  + ( 100 * biological_process_counter / all_pfams_encountered.size() )
1656                                                  + "%]" );
1657             ForesterUtil.programMessage( surfacing.PRG_NAME,
1658                                          "Pfams with mapping to molecular function: " + molecular_function_counter
1659                                                  + " ["
1660                                                  + ( 100 * molecular_function_counter / all_pfams_encountered.size() )
1661                                                  + "%]" );
1662             ForesterUtil.programMessage( surfacing.PRG_NAME,
1663                                          "Pfams with mapping to cellular component: " + cellular_component_counter
1664                                                  + " ["
1665                                                  + ( 100 * cellular_component_counter / all_pfams_encountered.size() )
1666                                                  + "%]" );
1667             summary_writer.write( ForesterUtil.LINE_SEPARATOR );
1668             summary_writer.write( "# Sum of Pfams encountered                : " + all_pfams_encountered.size() );
1669             summary_writer.write( ForesterUtil.LINE_SEPARATOR );
1670             summary_writer.write( "# Pfams without a mapping                 : " + pfams_without_mappings_counter
1671                     + " [" + ( 100 * pfams_without_mappings_counter / all_pfams_encountered.size() ) + "%]" );
1672             summary_writer.write( ForesterUtil.LINE_SEPARATOR );
1673             summary_writer.write( "# Pfams without mapping to proc. or func. : "
1674                     + pfams_without_mappings_to_bp_or_mf_counter + " ["
1675                     + ( 100 * pfams_without_mappings_to_bp_or_mf_counter / all_pfams_encountered.size() ) + "%]" );
1676             summary_writer.write( ForesterUtil.LINE_SEPARATOR );
1677             summary_writer.write( "# Pfams with a mapping                    : " + pfams_with_mappings_counter + " ["
1678                     + ( 100 * pfams_with_mappings_counter / all_pfams_encountered.size() ) + "%]" );
1679             summary_writer.write( ForesterUtil.LINE_SEPARATOR );
1680             summary_writer.write( "# Pfams with a mapping to proc. or func.  : "
1681                     + pfams_with_mappings_to_bp_or_mf_counter + " ["
1682                     + ( 100 * pfams_with_mappings_to_bp_or_mf_counter / all_pfams_encountered.size() ) + "%]" );
1683             summary_writer.write( ForesterUtil.LINE_SEPARATOR );
1684             summary_writer.write( "# Pfams with mapping to biological process: " + biological_process_counter + " ["
1685                     + ( 100 * biological_process_counter / all_pfams_encountered.size() ) + "%]" );
1686             summary_writer.write( ForesterUtil.LINE_SEPARATOR );
1687             summary_writer.write( "# Pfams with mapping to molecular function: " + molecular_function_counter + " ["
1688                     + ( 100 * molecular_function_counter / all_pfams_encountered.size() ) + "%]" );
1689             summary_writer.write( ForesterUtil.LINE_SEPARATOR );
1690             summary_writer.write( "# Pfams with mapping to cellular component: " + cellular_component_counter + " ["
1691                     + ( 100 * cellular_component_counter / all_pfams_encountered.size() ) + "%]" );
1692             summary_writer.write( ForesterUtil.LINE_SEPARATOR );
1693             summary_writer.close();
1694         }
1695         catch ( final IOException e ) {
1696             ForesterUtil.printWarningMessage( surfacing.PRG_NAME, "Failure to write: " + e );
1697         }
1698     }
1699
1700     public static void writeBinaryDomainCombinationsFileForGraphAnalysis( final String[][] input_file_properties,
1701                                                                           final File output_dir,
1702                                                                           final GenomeWideCombinableDomains gwcd,
1703                                                                           final int i,
1704                                                                           final GenomeWideCombinableDomainsSortOrder dc_sort_order ) {
1705         File dc_outfile_dot = new File( input_file_properties[ i ][ 0 ]
1706                 + surfacing.DOMAIN_COMBINITONS_OUTPUTFILE_SUFFIX_FOR_GRAPH_ANALYSIS );
1707         if ( output_dir != null ) {
1708             dc_outfile_dot = new File( output_dir + ForesterUtil.FILE_SEPARATOR + dc_outfile_dot );
1709         }
1710         checkForOutputFileWriteability( dc_outfile_dot );
1711         final SortedSet<BinaryDomainCombination> binary_combinations = createSetOfAllBinaryDomainCombinationsPerGenome( gwcd );
1712         try {
1713             final BufferedWriter out_dot = new BufferedWriter( new FileWriter( dc_outfile_dot ) );
1714             for( final BinaryDomainCombination bdc : binary_combinations ) {
1715                 out_dot.write( bdc.toGraphDescribingLanguage( BinaryDomainCombination.OutputFormat.DOT, null, null )
1716                         .toString() );
1717                 out_dot.write( SurfacingConstants.NL );
1718             }
1719             out_dot.close();
1720         }
1721         catch ( final IOException e ) {
1722             ForesterUtil.fatalError( surfacing.PRG_NAME, e.getMessage() );
1723         }
1724         ForesterUtil.programMessage( surfacing.PRG_NAME, "Wrote binary domain combination for \""
1725                 + input_file_properties[ i ][ 0 ] + "\" (" + input_file_properties[ i ][ 1 ] + ", "
1726                 + input_file_properties[ i ][ 2 ] + ") to: \"" + dc_outfile_dot + "\"" );
1727     }
1728
1729     public static void writeBinaryStatesMatrixAsListToFile( final CharacterStateMatrix<CharacterStateMatrix.GainLossStates> matrix,
1730                                                             final CharacterStateMatrix.GainLossStates state,
1731                                                             final String filename,
1732                                                             final String indentifier_characters_separator,
1733                                                             final String character_separator,
1734                                                             final Map<String, String> descriptions ) {
1735         final File outfile = new File( filename );
1736         checkForOutputFileWriteability( outfile );
1737         final SortedSet<String> sorted_ids = new TreeSet<String>();
1738         for( int i = 0; i < matrix.getNumberOfIdentifiers(); ++i ) {
1739             sorted_ids.add( matrix.getIdentifier( i ) );
1740         }
1741         try {
1742             final BufferedWriter out = new BufferedWriter( new FileWriter( outfile ) );
1743             for( final String id : sorted_ids ) {
1744                 out.write( indentifier_characters_separator );
1745                 out.write( "#" + id );
1746                 out.write( indentifier_characters_separator );
1747                 for( int c = 0; c < matrix.getNumberOfCharacters(); ++c ) {
1748                     // Not nice:
1749                     // using null to indicate either UNCHANGED_PRESENT or GAIN.
1750                     if ( ( matrix.getState( id, c ) == state )
1751                             || ( ( state == null ) && ( ( matrix.getState( id, c ) == CharacterStateMatrix.GainLossStates.GAIN ) || ( matrix
1752                                     .getState( id, c ) == CharacterStateMatrix.GainLossStates.UNCHANGED_PRESENT ) ) ) ) {
1753                         out.write( matrix.getCharacter( c ) );
1754                         if ( ( descriptions != null ) && !descriptions.isEmpty()
1755                                 && descriptions.containsKey( matrix.getCharacter( c ) ) ) {
1756                             out.write( "\t" );
1757                             out.write( descriptions.get( matrix.getCharacter( c ) ) );
1758                         }
1759                         out.write( character_separator );
1760                     }
1761                 }
1762             }
1763             out.flush();
1764             out.close();
1765         }
1766         catch ( final IOException e ) {
1767             ForesterUtil.fatalError( surfacing.PRG_NAME, e.getMessage() );
1768         }
1769         ForesterUtil.programMessage( surfacing.PRG_NAME, "Wrote characters list: \"" + filename + "\"" );
1770     }
1771
1772     public static void writeBinaryStatesMatrixAsListToFileForBinaryCombinationsForGraphAnalysis( final CharacterStateMatrix<CharacterStateMatrix.GainLossStates> matrix,
1773                                                                                                  final CharacterStateMatrix.GainLossStates state,
1774                                                                                                  final String filename,
1775                                                                                                  final String indentifier_characters_separator,
1776                                                                                                  final String character_separator,
1777                                                                                                  final BinaryDomainCombination.OutputFormat bc_output_format ) {
1778         final File outfile = new File( filename );
1779         checkForOutputFileWriteability( outfile );
1780         final SortedSet<String> sorted_ids = new TreeSet<String>();
1781         for( int i = 0; i < matrix.getNumberOfIdentifiers(); ++i ) {
1782             sorted_ids.add( matrix.getIdentifier( i ) );
1783         }
1784         try {
1785             final BufferedWriter out = new BufferedWriter( new FileWriter( outfile ) );
1786             for( final String id : sorted_ids ) {
1787                 out.write( indentifier_characters_separator );
1788                 out.write( "#" + id );
1789                 out.write( indentifier_characters_separator );
1790                 for( int c = 0; c < matrix.getNumberOfCharacters(); ++c ) {
1791                     // Not nice:
1792                     // using null to indicate either UNCHANGED_PRESENT or GAIN.
1793                     if ( ( matrix.getState( id, c ) == state )
1794                             || ( ( state == null ) && ( ( matrix.getState( id, c ) == CharacterStateMatrix.GainLossStates.GAIN ) || ( matrix
1795                                     .getState( id, c ) == CharacterStateMatrix.GainLossStates.UNCHANGED_PRESENT ) ) ) ) {
1796                         BinaryDomainCombination bdc = null;
1797                         try {
1798                             bdc = BasicBinaryDomainCombination.createInstance( matrix.getCharacter( c ) );
1799                         }
1800                         catch ( final Exception e ) {
1801                             ForesterUtil.fatalError( surfacing.PRG_NAME, e.getLocalizedMessage() );
1802                         }
1803                         out.write( bdc.toGraphDescribingLanguage( bc_output_format, null, null ).toString() );
1804                         out.write( character_separator );
1805                     }
1806                 }
1807             }
1808             out.flush();
1809             out.close();
1810         }
1811         catch ( final IOException e ) {
1812             ForesterUtil.fatalError( surfacing.PRG_NAME, e.getMessage() );
1813         }
1814         ForesterUtil.programMessage( surfacing.PRG_NAME, "Wrote characters list: \"" + filename + "\"" );
1815     }
1816
1817     public static void writeBinaryStatesMatrixToList( final Map<DomainId, List<GoId>> domain_id_to_go_ids_map,
1818                                                       final Map<GoId, GoTerm> go_id_to_term_map,
1819                                                       final GoNameSpace go_namespace_limit,
1820                                                       final boolean domain_combinations,
1821                                                       final CharacterStateMatrix<CharacterStateMatrix.GainLossStates> matrix,
1822                                                       final CharacterStateMatrix.GainLossStates state,
1823                                                       final String filename,
1824                                                       final String indentifier_characters_separator,
1825                                                       final String character_separator,
1826                                                       final String title_for_html,
1827                                                       final String prefix_for_html,
1828                                                       final Map<DomainId, Set<String>>[] domain_id_to_secondary_features_maps,
1829                                                       final SortedSet<String> all_pfams_encountered,
1830                                                       final SortedSet<String> pfams_gained_or_lost,
1831                                                       final String suffix_for_per_node_events_file ) {
1832         if ( ( go_namespace_limit != null ) && ( ( go_id_to_term_map == null ) || ( go_id_to_term_map.size() < 1 ) ) ) {
1833             throw new IllegalArgumentException( "attempt to use GO namespace limit without a GO-id to term map" );
1834         }
1835         else if ( ( ( domain_id_to_go_ids_map == null ) || ( domain_id_to_go_ids_map.size() < 1 ) ) ) {
1836             throw new IllegalArgumentException( "attempt to output detailed HTML without a Pfam to GO map" );
1837         }
1838         else if ( ( ( go_id_to_term_map == null ) || ( go_id_to_term_map.size() < 1 ) ) ) {
1839             throw new IllegalArgumentException( "attempt to output detailed HTML without a GO-id to term map" );
1840         }
1841         final File outfile = new File( filename );
1842         checkForOutputFileWriteability( outfile );
1843         final SortedSet<String> sorted_ids = new TreeSet<String>();
1844         for( int i = 0; i < matrix.getNumberOfIdentifiers(); ++i ) {
1845             sorted_ids.add( matrix.getIdentifier( i ) );
1846         }
1847         try {
1848             final Writer out = new BufferedWriter( new FileWriter( outfile ) );
1849             final File per_node_go_mapped_domain_gain_loss_files_base_dir = createBaseDirForPerNodeDomainFiles( surfacing.BASE_DIRECTORY_PER_NODE_DOMAIN_GAIN_LOSS_FILES,
1850                                                                                                                 domain_combinations,
1851                                                                                                                 state,
1852                                                                                                                 filename );
1853             Writer per_node_go_mapped_domain_gain_loss_outfile_writer = null;
1854             File per_node_go_mapped_domain_gain_loss_outfile = null;
1855             int per_node_counter = 0;
1856             out.write( "<html>" );
1857             out.write( SurfacingConstants.NL );
1858             addHtmlHead( out, title_for_html );
1859             out.write( SurfacingConstants.NL );
1860             out.write( "<body>" );
1861             out.write( SurfacingConstants.NL );
1862             out.write( "<h1>" );
1863             out.write( SurfacingConstants.NL );
1864             out.write( title_for_html );
1865             out.write( SurfacingConstants.NL );
1866             out.write( "</h1>" );
1867             out.write( SurfacingConstants.NL );
1868             out.write( "<table>" );
1869             out.write( SurfacingConstants.NL );
1870             for( final String id : sorted_ids ) {
1871                 final Matcher matcher = PATTERN_SP_STYLE_TAXONOMY.matcher( id );
1872                 if ( matcher.matches() ) {
1873                     continue;
1874                 }
1875                 out.write( "<tr>" );
1876                 out.write( "<td>" );
1877                 out.write( "<a href=\"#" + id + "\">" + id + "</a>" );
1878                 out.write( "</td>" );
1879                 out.write( "</tr>" );
1880                 out.write( SurfacingConstants.NL );
1881             }
1882             out.write( "</table>" );
1883             out.write( SurfacingConstants.NL );
1884             for( final String id : sorted_ids ) {
1885                 final Matcher matcher = PATTERN_SP_STYLE_TAXONOMY.matcher( id );
1886                 if ( matcher.matches() ) {
1887                     continue;
1888                 }
1889                 out.write( SurfacingConstants.NL );
1890                 out.write( "<h2>" );
1891                 out.write( "<a name=\"" + id + "\">" + id + "</a>" );
1892                 writeTaxonomyLinks( out, id );
1893                 out.write( "</h2>" );
1894                 out.write( SurfacingConstants.NL );
1895                 out.write( "<table>" );
1896                 out.write( SurfacingConstants.NL );
1897                 out.write( "<tr>" );
1898                 out.write( "<td><b>" );
1899                 out.write( "Pfam domain(s)" );
1900                 out.write( "</b></td><td><b>" );
1901                 out.write( "GO term acc" );
1902                 out.write( "</b></td><td><b>" );
1903                 out.write( "GO term" );
1904                 out.write( "</b></td><td><b>" );
1905                 out.write( "GO namespace" );
1906                 out.write( "</b></td>" );
1907                 out.write( "</tr>" );
1908                 out.write( SurfacingConstants.NL );
1909                 out.write( "</tr>" );
1910                 out.write( SurfacingConstants.NL );
1911                 per_node_counter = 0;
1912                 if ( matrix.getNumberOfCharacters() > 0 ) {
1913                     per_node_go_mapped_domain_gain_loss_outfile = new File( per_node_go_mapped_domain_gain_loss_files_base_dir
1914                             + ForesterUtil.FILE_SEPARATOR + id + suffix_for_per_node_events_file );
1915                     SurfacingUtil.checkForOutputFileWriteability( per_node_go_mapped_domain_gain_loss_outfile );
1916                     per_node_go_mapped_domain_gain_loss_outfile_writer = ForesterUtil
1917                             .createBufferedWriter( per_node_go_mapped_domain_gain_loss_outfile );
1918                 }
1919                 else {
1920                     per_node_go_mapped_domain_gain_loss_outfile = null;
1921                     per_node_go_mapped_domain_gain_loss_outfile_writer = null;
1922                 }
1923                 for( int c = 0; c < matrix.getNumberOfCharacters(); ++c ) {
1924                     // Not nice:
1925                     // using null to indicate either UNCHANGED_PRESENT or GAIN.
1926                     if ( ( matrix.getState( id, c ) == state )
1927                             || ( ( state == null ) && ( ( matrix.getState( id, c ) == CharacterStateMatrix.GainLossStates.UNCHANGED_PRESENT ) || ( matrix
1928                                     .getState( id, c ) == CharacterStateMatrix.GainLossStates.GAIN ) ) ) ) {
1929                         final String character = matrix.getCharacter( c );
1930                         String domain_0 = "";
1931                         String domain_1 = "";
1932                         if ( character.indexOf( BinaryDomainCombination.SEPARATOR ) > 0 ) {
1933                             final String[] s = character.split( BinaryDomainCombination.SEPARATOR );
1934                             if ( s.length != 2 ) {
1935                                 throw new AssertionError( "this should not have happened: unexpected format for domain combination: ["
1936                                         + character + "]" );
1937                             }
1938                             domain_0 = s[ 0 ];
1939                             domain_1 = s[ 1 ];
1940                         }
1941                         else {
1942                             domain_0 = character;
1943                         }
1944                         writeDomainData( domain_id_to_go_ids_map,
1945                                          go_id_to_term_map,
1946                                          go_namespace_limit,
1947                                          out,
1948                                          domain_0,
1949                                          domain_1,
1950                                          prefix_for_html,
1951                                          character_separator,
1952                                          domain_id_to_secondary_features_maps,
1953                                          null );
1954                         all_pfams_encountered.add( domain_0 );
1955                         if ( pfams_gained_or_lost != null ) {
1956                             pfams_gained_or_lost.add( domain_0 );
1957                         }
1958                         if ( !ForesterUtil.isEmpty( domain_1 ) ) {
1959                             all_pfams_encountered.add( domain_1 );
1960                             if ( pfams_gained_or_lost != null ) {
1961                                 pfams_gained_or_lost.add( domain_1 );
1962                             }
1963                         }
1964                         if ( per_node_go_mapped_domain_gain_loss_outfile_writer != null ) {
1965                             writeDomainsToIndividualFilePerTreeNode( per_node_go_mapped_domain_gain_loss_outfile_writer,
1966                                                                      domain_0,
1967                                                                      domain_1 );
1968                             per_node_counter++;
1969                         }
1970                     }
1971                 }
1972                 if ( per_node_go_mapped_domain_gain_loss_outfile_writer != null ) {
1973                     per_node_go_mapped_domain_gain_loss_outfile_writer.close();
1974                     if ( per_node_counter < 1 ) {
1975                         per_node_go_mapped_domain_gain_loss_outfile.delete();
1976                     }
1977                     per_node_counter = 0;
1978                 }
1979                 out.write( "</table>" );
1980                 out.write( SurfacingConstants.NL );
1981                 out.write( "<hr>" );
1982                 out.write( SurfacingConstants.NL );
1983             } // for( final String id : sorted_ids ) {
1984             out.write( "</body>" );
1985             out.write( SurfacingConstants.NL );
1986             out.write( "</html>" );
1987             out.write( SurfacingConstants.NL );
1988             out.flush();
1989             out.close();
1990         }
1991         catch ( final IOException e ) {
1992             ForesterUtil.fatalError( surfacing.PRG_NAME, e.getMessage() );
1993         }
1994         ForesterUtil.programMessage( surfacing.PRG_NAME, "Wrote characters detailed HTML list: \"" + filename + "\"" );
1995     }
1996
1997     public static void writeDomainCombinationsCountsFile( final String[][] input_file_properties,
1998                                                           final File output_dir,
1999                                                           final Writer per_genome_domain_promiscuity_statistics_writer,
2000                                                           final GenomeWideCombinableDomains gwcd,
2001                                                           final int i,
2002                                                           final GenomeWideCombinableDomains.GenomeWideCombinableDomainsSortOrder dc_sort_order ) {
2003         File dc_outfile = new File( input_file_properties[ i ][ 0 ]
2004                 + surfacing.DOMAIN_COMBINITON_COUNTS_OUTPUTFILE_SUFFIX );
2005         if ( output_dir != null ) {
2006             dc_outfile = new File( output_dir + ForesterUtil.FILE_SEPARATOR + dc_outfile );
2007         }
2008         checkForOutputFileWriteability( dc_outfile );
2009         try {
2010             final BufferedWriter out = new BufferedWriter( new FileWriter( dc_outfile ) );
2011             out.write( gwcd.toStringBuilder( dc_sort_order ).toString() );
2012             out.close();
2013         }
2014         catch ( final IOException e ) {
2015             ForesterUtil.fatalError( surfacing.PRG_NAME, e.getMessage() );
2016         }
2017         final DescriptiveStatistics stats = gwcd.getPerGenomeDomainPromiscuityStatistics();
2018         try {
2019             per_genome_domain_promiscuity_statistics_writer.write( input_file_properties[ i ][ 0 ] + "\t" );
2020             per_genome_domain_promiscuity_statistics_writer.write( FORMATTER_3.format( stats.arithmeticMean() ) + "\t" );
2021             if ( stats.getN() < 2 ) {
2022                 per_genome_domain_promiscuity_statistics_writer.write( "n/a" + "\t" );
2023             }
2024             else {
2025                 per_genome_domain_promiscuity_statistics_writer.write( FORMATTER_3.format( stats
2026                         .sampleStandardDeviation() ) + "\t" );
2027             }
2028             per_genome_domain_promiscuity_statistics_writer.write( FORMATTER_3.format( stats.median() ) + "\t" );
2029             per_genome_domain_promiscuity_statistics_writer.write( ( int ) stats.getMin() + "\t" );
2030             per_genome_domain_promiscuity_statistics_writer.write( ( int ) stats.getMax() + "\t" );
2031             per_genome_domain_promiscuity_statistics_writer.write( stats.getN() + "\t" );
2032             final SortedSet<DomainId> mpds = gwcd.getMostPromiscuosDomain();
2033             for( final DomainId mpd : mpds ) {
2034                 per_genome_domain_promiscuity_statistics_writer.write( mpd.getId() + " " );
2035             }
2036             per_genome_domain_promiscuity_statistics_writer.write( ForesterUtil.LINE_SEPARATOR );
2037         }
2038         catch ( final IOException e ) {
2039             ForesterUtil.fatalError( surfacing.PRG_NAME, e.getMessage() );
2040         }
2041         if ( input_file_properties[ i ].length == 3 ) {
2042             ForesterUtil.programMessage( surfacing.PRG_NAME, "Wrote domain combination counts for \""
2043                     + input_file_properties[ i ][ 0 ] + "\" (" + input_file_properties[ i ][ 1 ] + ", "
2044                     + input_file_properties[ i ][ 2 ] + ") to: \"" + dc_outfile + "\"" );
2045         }
2046         else {
2047             ForesterUtil.programMessage( surfacing.PRG_NAME, "Wrote domain combination counts for \""
2048                     + input_file_properties[ i ][ 0 ] + "\" (" + input_file_properties[ i ][ 1 ] + ") to: \""
2049                     + dc_outfile + "\"" );
2050         }
2051     }
2052
2053     private static void writeDomainData( final Map<DomainId, List<GoId>> domain_id_to_go_ids_map,
2054                                          final Map<GoId, GoTerm> go_id_to_term_map,
2055                                          final GoNameSpace go_namespace_limit,
2056                                          final Writer out,
2057                                          final String domain_0,
2058                                          final String domain_1,
2059                                          final String prefix_for_html,
2060                                          final String character_separator_for_non_html_output,
2061                                          final Map<DomainId, Set<String>>[] domain_id_to_secondary_features_maps,
2062                                          final Set<GoId> all_go_ids ) throws IOException {
2063         boolean any_go_annotation_present = false;
2064         boolean first_has_no_go = false;
2065         int domain_count = 2; // To distinguish between domains and binary domain combinations.
2066         if ( ForesterUtil.isEmpty( domain_1 ) ) {
2067             domain_count = 1;
2068         }
2069         // The following has a difficult to understand logic.
2070         for( int d = 0; d < domain_count; ++d ) {
2071             List<GoId> go_ids = null;
2072             boolean go_annotation_present = false;
2073             if ( d == 0 ) {
2074                 final DomainId domain_id = new DomainId( domain_0 );
2075                 if ( domain_id_to_go_ids_map.containsKey( domain_id ) ) {
2076                     go_annotation_present = true;
2077                     any_go_annotation_present = true;
2078                     go_ids = domain_id_to_go_ids_map.get( domain_id );
2079                 }
2080                 else {
2081                     first_has_no_go = true;
2082                 }
2083             }
2084             else {
2085                 final DomainId domain_id = new DomainId( domain_1 );
2086                 if ( domain_id_to_go_ids_map.containsKey( domain_id ) ) {
2087                     go_annotation_present = true;
2088                     any_go_annotation_present = true;
2089                     go_ids = domain_id_to_go_ids_map.get( domain_id );
2090                 }
2091             }
2092             if ( go_annotation_present ) {
2093                 boolean first = ( ( d == 0 ) || ( ( d == 1 ) && first_has_no_go ) );
2094                 for( final GoId go_id : go_ids ) {
2095                     out.write( "<tr>" );
2096                     if ( first ) {
2097                         first = false;
2098                         writeDomainIdsToHtml( out,
2099                                               domain_0,
2100                                               domain_1,
2101                                               prefix_for_html,
2102                                               domain_id_to_secondary_features_maps );
2103                     }
2104                     else {
2105                         out.write( "<td></td>" );
2106                     }
2107                     if ( !go_id_to_term_map.containsKey( go_id ) ) {
2108                         throw new IllegalArgumentException( "GO-id [" + go_id + "] not found in GO-id to GO-term map" );
2109                     }
2110                     final GoTerm go_term = go_id_to_term_map.get( go_id );
2111                     if ( ( go_namespace_limit == null ) || go_namespace_limit.equals( go_term.getGoNameSpace() ) ) {
2112                         // final String top = GoUtils.getPenultimateGoTerm( go_term, go_id_to_term_map ).getName();
2113                         final String go_id_str = go_id.getId();
2114                         out.write( "<td>" );
2115                         out.write( "<a href=\"" + SurfacingConstants.AMIGO_LINK + go_id_str
2116                                 + "\" target=\"amigo_window\">" + go_id_str + "</a>" );
2117                         out.write( "</td><td>" );
2118                         out.write( go_term.getName() );
2119                         if ( domain_count == 2 ) {
2120                             out.write( " (" + d + ")" );
2121                         }
2122                         out.write( "</td><td>" );
2123                         // out.write( top );
2124                         // out.write( "</td><td>" );
2125                         out.write( "[" );
2126                         out.write( go_term.getGoNameSpace().toShortString() );
2127                         out.write( "]" );
2128                         out.write( "</td>" );
2129                         if ( all_go_ids != null ) {
2130                             all_go_ids.add( go_id );
2131                         }
2132                     }
2133                     else {
2134                         out.write( "<td>" );
2135                         out.write( "</td><td>" );
2136                         out.write( "</td><td>" );
2137                         out.write( "</td><td>" );
2138                         out.write( "</td>" );
2139                     }
2140                     out.write( "</tr>" );
2141                     out.write( SurfacingConstants.NL );
2142                 }
2143             }
2144         } //  for( int d = 0; d < domain_count; ++d )
2145         if ( !any_go_annotation_present ) {
2146             out.write( "<tr>" );
2147             writeDomainIdsToHtml( out, domain_0, domain_1, prefix_for_html, domain_id_to_secondary_features_maps );
2148             out.write( "<td>" );
2149             out.write( "</td><td>" );
2150             out.write( "</td><td>" );
2151             out.write( "</td><td>" );
2152             out.write( "</td>" );
2153             out.write( "</tr>" );
2154             out.write( SurfacingConstants.NL );
2155         }
2156     }
2157
2158     private static void writeDomainIdsToHtml( final Writer out,
2159                                               final String domain_0,
2160                                               final String domain_1,
2161                                               final String prefix_for_detailed_html,
2162                                               final Map<DomainId, Set<String>>[] domain_id_to_secondary_features_maps )
2163             throws IOException {
2164         out.write( "<td>" );
2165         if ( !ForesterUtil.isEmpty( prefix_for_detailed_html ) ) {
2166             out.write( prefix_for_detailed_html );
2167             out.write( " " );
2168         }
2169         out.write( "<a href=\"" + SurfacingConstants.PFAM_FAMILY_ID_LINK + domain_0 + "\">" + domain_0 + "</a>" );
2170         out.write( "</td>" );
2171     }
2172
2173     public static DescriptiveStatistics writeDomainSimilaritiesToFile( final StringBuilder html_desc,
2174                                                                        final StringBuilder html_title,
2175                                                                        final Writer single_writer,
2176                                                                        Map<Character, Writer> split_writers,
2177                                                                        final SortedSet<DomainSimilarity> similarities,
2178                                                                        final boolean treat_as_binary,
2179                                                                        final List<Species> species_order,
2180                                                                        final PrintableDomainSimilarity.PRINT_OPTION print_option,
2181                                                                        final DomainSimilarity.DomainSimilaritySortField sort_field,
2182                                                                        final DomainSimilarity.DomainSimilarityScoring scoring,
2183                                                                        final boolean verbose ) throws IOException {
2184         final DescriptiveStatistics stats = new BasicDescriptiveStatistics();
2185         String histogram_title = null;
2186         switch ( sort_field ) {
2187             case ABS_MAX_COUNTS_DIFFERENCE:
2188                 if ( treat_as_binary ) {
2189                     histogram_title = "absolute counts difference:";
2190                 }
2191                 else {
2192                     histogram_title = "absolute (maximal) counts difference:";
2193                 }
2194                 break;
2195             case MAX_COUNTS_DIFFERENCE:
2196                 if ( treat_as_binary ) {
2197                     histogram_title = "counts difference:";
2198                 }
2199                 else {
2200                     histogram_title = "(maximal) counts difference:";
2201                 }
2202                 break;
2203             case DOMAIN_ID:
2204                 histogram_title = "score mean:";
2205                 break;
2206             case MIN:
2207                 histogram_title = "score minimum:";
2208                 break;
2209             case MAX:
2210                 histogram_title = "score maximum:";
2211                 break;
2212             case MAX_DIFFERENCE:
2213                 if ( treat_as_binary ) {
2214                     histogram_title = "difference:";
2215                 }
2216                 else {
2217                     histogram_title = "(maximal) difference:";
2218                 }
2219                 break;
2220             case MEAN:
2221                 histogram_title = "score mean:";
2222                 break;
2223             case SD:
2224                 histogram_title = "score standard deviation:";
2225                 break;
2226             case SPECIES_COUNT:
2227                 histogram_title = "species number:";
2228                 break;
2229             default:
2230                 throw new AssertionError( "Unknown sort field: " + sort_field );
2231         }
2232         for( final DomainSimilarity similarity : similarities ) {
2233             switch ( sort_field ) {
2234                 case ABS_MAX_COUNTS_DIFFERENCE:
2235                     stats.addValue( Math.abs( similarity.getMaximalDifferenceInCounts() ) );
2236                     break;
2237                 case MAX_COUNTS_DIFFERENCE:
2238                     stats.addValue( similarity.getMaximalDifferenceInCounts() );
2239                     break;
2240                 case DOMAIN_ID:
2241                     stats.addValue( similarity.getMeanSimilarityScore() );
2242                     break;
2243                 case MIN:
2244                     stats.addValue( similarity.getMinimalSimilarityScore() );
2245                     break;
2246                 case MAX:
2247                     stats.addValue( similarity.getMaximalSimilarityScore() );
2248                     break;
2249                 case MAX_DIFFERENCE:
2250                     stats.addValue( similarity.getMaximalDifference() );
2251                     break;
2252                 case MEAN:
2253                     stats.addValue( similarity.getMeanSimilarityScore() );
2254                     break;
2255                 case SD:
2256                     stats.addValue( similarity.getStandardDeviationOfSimilarityScore() );
2257                     break;
2258                 case SPECIES_COUNT:
2259                     stats.addValue( similarity.getSpecies().size() );
2260                     break;
2261                 default:
2262                     throw new AssertionError( "Unknown sort field: " + sort_field );
2263             }
2264         }
2265         //
2266         // final HistogramData[] hists = new HistogramData[ 1 ];
2267         //
2268         //
2269         // List<HistogramDataItem> data_items = new
2270         // ArrayList<HistogramDataItem>();
2271         // double[] values = stats.getDataAsDoubleArray();
2272         // for( int i = 0; i < values.length; i++ ) {
2273         // HistogramDataItem data_item = new BasicHistogramDataItem( "", values[
2274         // i ] );
2275         // data_items.add( data_item );
2276         // }
2277         //
2278         //
2279         // HistogramData hd0 = new HistogramData( "name",
2280         // data_items,
2281         // null, 20,
2282         // 40 );
2283         //
2284         //
2285         //
2286         //
2287         // hists[ 0 ] = hd0;
2288         //
2289         // final HistogramsFrame hf = new HistogramsFrame( hists );
2290         // hf.setVisible( true );
2291         //
2292         AsciiHistogram histo = null;
2293         if ( stats.getMin() < stats.getMin() ) {
2294             histo = new AsciiHistogram( stats, histogram_title );
2295         }
2296         if ( verbose ) {
2297             if ( histo != null ) {
2298                 System.out.println( histo.toStringBuffer( 20, '|', 40, 5 ) );
2299             }
2300             System.out.println();
2301             System.out.println( "N                   : " + stats.getN() );
2302             System.out.println( "Min                 : " + stats.getMin() );
2303             System.out.println( "Max                 : " + stats.getMax() );
2304             System.out.println( "Mean                : " + stats.arithmeticMean() );
2305             if ( stats.getN() > 1 ) {
2306                 System.out.println( "SD                  : " + stats.sampleStandardDeviation() );
2307             }
2308             else {
2309                 System.out.println( "SD                  : n/a" );
2310             }
2311             System.out.println( "Median              : " + stats.median() );
2312             if ( stats.getN() > 1 ) {
2313                 System.out.println( "Pearsonian skewness : " + stats.pearsonianSkewness() );
2314             }
2315             else {
2316                 System.out.println( "Pearsonian skewness : n/a" );
2317             }
2318         }
2319         if ( ( single_writer != null ) && ( ( split_writers == null ) || split_writers.isEmpty() ) ) {
2320             split_writers = new HashMap<Character, Writer>();
2321             split_writers.put( '_', single_writer );
2322         }
2323         switch ( print_option ) {
2324             case SIMPLE_TAB_DELIMITED:
2325                 break;
2326             case HTML:
2327                 for( final Character key : split_writers.keySet() ) {
2328                     final Writer w = split_writers.get( key );
2329                     w.write( "<html>" );
2330                     w.write( SurfacingConstants.NL );
2331                     if ( key != '_' ) {
2332                         addHtmlHead( w, "DCs (" + html_title + ") " + key.toString().toUpperCase() );
2333                     }
2334                     else {
2335                         addHtmlHead( w, "DCs (" + html_title + ")" );
2336                     }
2337                     w.write( SurfacingConstants.NL );
2338                     w.write( "<body>" );
2339                     w.write( SurfacingConstants.NL );
2340                     w.write( html_desc.toString() );
2341                     w.write( SurfacingConstants.NL );
2342                     w.write( "<hr>" );
2343                     w.write( "<br>" );
2344                     w.write( SurfacingConstants.NL );
2345                     w.write( "<tt><pre>" );
2346                     w.write( SurfacingConstants.NL );
2347                     if ( histo != null ) {
2348                         w.write( histo.toStringBuffer( 20, '|', 40, 5 ).toString() );
2349                         w.write( SurfacingConstants.NL );
2350                     }
2351                     w.write( "</pre></tt>" );
2352                     w.write( SurfacingConstants.NL );
2353                     w.write( "<table>" );
2354                     w.write( SurfacingConstants.NL );
2355                     w.write( "<tr><td>N: </td><td>" + stats.getN() + "</td></tr>" );
2356                     w.write( SurfacingConstants.NL );
2357                     w.write( "<tr><td>Min: </td><td>" + stats.getMin() + "</td></tr>" );
2358                     w.write( SurfacingConstants.NL );
2359                     w.write( "<tr><td>Max: </td><td>" + stats.getMax() + "</td></tr>" );
2360                     w.write( SurfacingConstants.NL );
2361                     w.write( "<tr><td>Mean: </td><td>" + stats.arithmeticMean() + "</td></tr>" );
2362                     w.write( SurfacingConstants.NL );
2363                     if ( stats.getN() > 1 ) {
2364                         w.write( "<tr><td>SD: </td><td>" + stats.sampleStandardDeviation() + "</td></tr>" );
2365                     }
2366                     else {
2367                         w.write( "<tr><td>SD: </td><td>n/a</td></tr>" );
2368                     }
2369                     w.write( SurfacingConstants.NL );
2370                     w.write( "<tr><td>Median: </td><td>" + stats.median() + "</td></tr>" );
2371                     w.write( SurfacingConstants.NL );
2372                     if ( stats.getN() > 1 ) {
2373                         w.write( "<tr><td>Pearsonian skewness: </td><td>" + stats.pearsonianSkewness() + "</td></tr>" );
2374                     }
2375                     else {
2376                         w.write( "<tr><td>Pearsonian skewness: </td><td>n/a</td></tr>" );
2377                     }
2378                     w.write( SurfacingConstants.NL );
2379                     w.write( "</table>" );
2380                     w.write( SurfacingConstants.NL );
2381                     w.write( "<br>" );
2382                     w.write( SurfacingConstants.NL );
2383                     w.write( "<hr>" );
2384                     w.write( SurfacingConstants.NL );
2385                     w.write( "<br>" );
2386                     w.write( SurfacingConstants.NL );
2387                     w.write( "<table>" );
2388                     w.write( SurfacingConstants.NL );
2389                 }
2390                 break;
2391         }
2392         for( final Writer w : split_writers.values() ) {
2393             w.write( SurfacingConstants.NL );
2394         }
2395         for( final DomainSimilarity similarity : similarities ) {
2396             if ( ( species_order != null ) && !species_order.isEmpty() ) {
2397                 ( ( PrintableDomainSimilarity ) similarity ).setSpeciesOrder( species_order );
2398             }
2399             if ( single_writer != null ) {
2400                 single_writer.write( similarity.toStringBuffer( print_option ).toString() );
2401             }
2402             else {
2403                 Writer local_writer = split_writers.get( ( similarity.getDomainId().getId().charAt( 0 ) + "" )
2404                         .toLowerCase().charAt( 0 ) );
2405                 if ( local_writer == null ) {
2406                     local_writer = split_writers.get( '0' );
2407                 }
2408                 local_writer.write( similarity.toStringBuffer( print_option ).toString() );
2409             }
2410             for( final Writer w : split_writers.values() ) {
2411                 w.write( SurfacingConstants.NL );
2412             }
2413         }
2414         switch ( print_option ) {
2415             case HTML:
2416                 for( final Writer w : split_writers.values() ) {
2417                     w.write( SurfacingConstants.NL );
2418                     w.write( "</table>" );
2419                     w.write( SurfacingConstants.NL );
2420                     w.write( "</font>" );
2421                     w.write( SurfacingConstants.NL );
2422                     w.write( "</body>" );
2423                     w.write( SurfacingConstants.NL );
2424                     w.write( "</html>" );
2425                     w.write( SurfacingConstants.NL );
2426                 }
2427                 break;
2428         }
2429         for( final Writer w : split_writers.values() ) {
2430             w.close();
2431         }
2432         return stats;
2433     }
2434
2435     private static void writeDomainsToIndividualFilePerTreeNode( final Writer individual_files_writer,
2436                                                                  final String domain_0,
2437                                                                  final String domain_1 ) throws IOException {
2438         individual_files_writer.write( domain_0 );
2439         individual_files_writer.write( ForesterUtil.LINE_SEPARATOR );
2440         if ( !ForesterUtil.isEmpty( domain_1 ) ) {
2441             individual_files_writer.write( domain_1 );
2442             individual_files_writer.write( ForesterUtil.LINE_SEPARATOR );
2443         }
2444     }
2445
2446     public static void writeMatrixToFile( final CharacterStateMatrix<?> matrix,
2447                                           final String filename,
2448                                           final Format format ) {
2449         final File outfile = new File( filename );
2450         checkForOutputFileWriteability( outfile );
2451         try {
2452             final BufferedWriter out = new BufferedWriter( new FileWriter( outfile ) );
2453             matrix.toWriter( out, format );
2454             out.flush();
2455             out.close();
2456         }
2457         catch ( final IOException e ) {
2458             ForesterUtil.fatalError( surfacing.PRG_NAME, e.getMessage() );
2459         }
2460         ForesterUtil.programMessage( surfacing.PRG_NAME, "Wrote matrix: \"" + filename + "\"" );
2461     }
2462
2463     public static void writeMatrixToFile( final File matrix_outfile, final List<DistanceMatrix> matrices ) {
2464         checkForOutputFileWriteability( matrix_outfile );
2465         try {
2466             final BufferedWriter out = new BufferedWriter( new FileWriter( matrix_outfile ) );
2467             for( final DistanceMatrix distance_matrix : matrices ) {
2468                 out.write( distance_matrix.toStringBuffer( DistanceMatrix.Format.PHYLIP ).toString() );
2469                 out.write( ForesterUtil.LINE_SEPARATOR );
2470                 out.flush();
2471             }
2472             out.close();
2473         }
2474         catch ( final IOException e ) {
2475             ForesterUtil.fatalError( surfacing.PRG_NAME, e.getMessage() );
2476         }
2477         ForesterUtil.programMessage( surfacing.PRG_NAME, "Wrote distance matrices to \"" + matrix_outfile + "\"" );
2478     }
2479
2480     private static void writePfamsToFile( final String outfile_name, final SortedSet<String> pfams ) {
2481         try {
2482             final Writer writer = new BufferedWriter( new FileWriter( new File( outfile_name ) ) );
2483             for( final String pfam : pfams ) {
2484                 writer.write( pfam );
2485                 writer.write( ForesterUtil.LINE_SEPARATOR );
2486             }
2487             writer.close();
2488             ForesterUtil.programMessage( surfacing.PRG_NAME, "Wrote " + pfams.size() + " pfams to [" + outfile_name
2489                     + "]" );
2490         }
2491         catch ( final IOException e ) {
2492             ForesterUtil.printWarningMessage( surfacing.PRG_NAME, "Failure to write: " + e );
2493         }
2494     }
2495
2496     public static void writePhylogenyToFile( final Phylogeny phylogeny, final String filename ) {
2497         final PhylogenyWriter writer = new PhylogenyWriter();
2498         try {
2499             writer.toPhyloXML( new File( filename ), phylogeny, 1 );
2500         }
2501         catch ( final IOException e ) {
2502             ForesterUtil.printWarningMessage( surfacing.PRG_NAME, "failed to write phylogeny to \"" + filename + "\": "
2503                     + e );
2504         }
2505         ForesterUtil.programMessage( surfacing.PRG_NAME, "Wrote phylogeny to \"" + filename + "\"" );
2506     }
2507
2508     public static void writeTaxonomyLinks( final Writer writer, final String species ) throws IOException {
2509         if ( ( species.length() > 1 ) && ( species.indexOf( '_' ) < 1 ) ) {
2510             final Matcher matcher = PATTERN_SP_STYLE_TAXONOMY.matcher( species );
2511             writer.write( " [" );
2512             if ( matcher.matches() ) {
2513                 writer.write( "<a href=\"" + SurfacingConstants.UNIPROT_LINK + species
2514                         + "\" target=\"taxonomy_window\">uniprot</a>" );
2515             }
2516             else {
2517                 writer.write( "<a href=\"" + SurfacingConstants.EOL_LINK + species
2518                         + "\" target=\"taxonomy_window\">eol</a>" );
2519                 writer.write( "|" );
2520                 writer.write( "<a href=\"" + SurfacingConstants.TOL_LINK + species
2521                         + "\" target=\"taxonomy_window\">tol</a>" );
2522             }
2523             writer.write( "]" );
2524         }
2525     }
2526
2527     private static void writeToNexus( final String outfile_name,
2528                                       final CharacterStateMatrix<BinaryStates> matrix,
2529                                       final Phylogeny phylogeny ) {
2530         if ( !( matrix instanceof BasicCharacterStateMatrix ) ) {
2531             throw new IllegalArgumentException( "can only write matrices of type [" + BasicCharacterStateMatrix.class
2532                     + "] to nexus" );
2533         }
2534         final BasicCharacterStateMatrix<BinaryStates> my_matrix = ( org.forester.evoinference.matrix.character.BasicCharacterStateMatrix<BinaryStates> ) matrix;
2535         final List<Phylogeny> phylogenies = new ArrayList<Phylogeny>( 1 );
2536         phylogenies.add( phylogeny );
2537         try {
2538             final BufferedWriter w = new BufferedWriter( new FileWriter( outfile_name ) );
2539             w.write( NexusConstants.NEXUS );
2540             w.write( ForesterUtil.LINE_SEPARATOR );
2541             my_matrix.writeNexusTaxaBlock( w );
2542             my_matrix.writeNexusBinaryChractersBlock( w );
2543             PhylogenyWriter.writeNexusTreesBlock( w, phylogenies, NH_CONVERSION_SUPPORT_VALUE_STYLE.NONE );
2544             w.flush();
2545             w.close();
2546             ForesterUtil.programMessage( surfacing.PRG_NAME, "Wrote Nexus file: \"" + outfile_name + "\"" );
2547         }
2548         catch ( final IOException e ) {
2549             ForesterUtil.fatalError( surfacing.PRG_NAME, e.getMessage() );
2550         }
2551     }
2552
2553     private static void writeToNexus( final String outfile_name,
2554                                       final DomainParsimonyCalculator domain_parsimony,
2555                                       final Phylogeny phylogeny ) {
2556         writeToNexus( outfile_name + surfacing.NEXUS_EXTERNAL_DOMAINS,
2557                       domain_parsimony.createMatrixOfDomainPresenceOrAbsence(),
2558                       phylogeny );
2559         writeToNexus( outfile_name + surfacing.NEXUS_EXTERNAL_DOMAIN_COMBINATIONS,
2560                       domain_parsimony.createMatrixOfBinaryDomainCombinationPresenceOrAbsence(),
2561                       phylogeny );
2562     }
2563
2564     public static void domainsPerProteinsStatistics( final String genome,
2565                                                      final List<Protein> protein_list,
2566                                                      final DescriptiveStatistics all_genomes_domains_per_potein_stats,
2567                                                      final SortedMap<Integer, Integer> all_genomes_domains_per_potein_histo,
2568                                                      final SortedSet<String> domains_which_are_always_single,
2569                                                      final SortedSet<String> domains_which_are_sometimes_single_sometimes_not,
2570                                                      final SortedSet<String> domains_which_never_single,
2571                                                      final Writer writer ) {
2572         final DescriptiveStatistics stats = new BasicDescriptiveStatistics();
2573         for( final Protein protein : protein_list ) {
2574             final int domains = protein.getNumberOfProteinDomains();
2575             //System.out.println( domains );
2576             stats.addValue( domains );
2577             all_genomes_domains_per_potein_stats.addValue( domains );
2578             if ( !all_genomes_domains_per_potein_histo.containsKey( domains ) ) {
2579                 all_genomes_domains_per_potein_histo.put( domains, 1 );
2580             }
2581             else {
2582                 all_genomes_domains_per_potein_histo.put( domains,
2583                                                           1 + all_genomes_domains_per_potein_histo.get( domains ) );
2584             }
2585             if ( domains == 1 ) {
2586                 final String domain = protein.getProteinDomain( 0 ).getDomainId().getId();
2587                 if ( !domains_which_are_sometimes_single_sometimes_not.contains( domain ) ) {
2588                     if ( domains_which_never_single.contains( domain ) ) {
2589                         domains_which_never_single.remove( domain );
2590                         domains_which_are_sometimes_single_sometimes_not.add( domain );
2591                     }
2592                     else {
2593                         domains_which_are_always_single.add( domain );
2594                     }
2595                 }
2596             }
2597             else if ( domains > 1 ) {
2598                 for( final Domain d : protein.getProteinDomains() ) {
2599                     final String domain = d.getDomainId().getId();
2600                     // System.out.println( domain );
2601                     if ( !domains_which_are_sometimes_single_sometimes_not.contains( domain ) ) {
2602                         if ( domains_which_are_always_single.contains( domain ) ) {
2603                             domains_which_are_always_single.remove( domain );
2604                             domains_which_are_sometimes_single_sometimes_not.add( domain );
2605                         }
2606                         else {
2607                             domains_which_never_single.add( domain );
2608                         }
2609                     }
2610                 }
2611             }
2612         }
2613         try {
2614             writer.write( genome );
2615             writer.write( "\t" );
2616             if ( stats.getN() >= 1 ) {
2617                 writer.write( stats.arithmeticMean() + "" );
2618                 writer.write( "\t" );
2619                 if ( stats.getN() >= 2 ) {
2620                     writer.write( stats.sampleStandardDeviation() + "" );
2621                 }
2622                 else {
2623                     writer.write( "" );
2624                 }
2625                 writer.write( "\t" );
2626                 writer.write( stats.median() + "" );
2627                 writer.write( "\t" );
2628                 writer.write( stats.getN() + "" );
2629                 writer.write( "\t" );
2630                 writer.write( stats.getMin() + "" );
2631                 writer.write( "\t" );
2632                 writer.write( stats.getMax() + "" );
2633             }
2634             else {
2635                 writer.write( "\t" );
2636                 writer.write( "\t" );
2637                 writer.write( "\t" );
2638                 writer.write( "0" );
2639                 writer.write( "\t" );
2640                 writer.write( "\t" );
2641             }
2642             writer.write( "\n" );
2643         }
2644         catch ( final IOException e ) {
2645             e.printStackTrace();
2646         }
2647     }
2648
2649     final static class DomainComparator implements Comparator<Domain> {
2650
2651         final private boolean _ascending;
2652
2653         public DomainComparator( final boolean ascending ) {
2654             _ascending = ascending;
2655         }
2656
2657         @Override
2658         public final int compare( final Domain d0, final Domain d1 ) {
2659
2660             if ( d0.getFrom() < d1.getFrom() ) {
2661                 return _ascending ? -1 : 1;
2662             }
2663             else if ( d0.getFrom() > d1.getFrom() ) {
2664                 return _ascending ? 1 : -1;
2665             }
2666             return 0;
2667
2668         }
2669
2670     }
2671 }
2672
2673
2674
2675
2676