inprogress
authorcmzmasek@gmail.com <cmzmasek@gmail.com@ca865154-3058-d1c3-3e42-d8f55a55bdbd>
Wed, 7 May 2014 02:58:20 +0000 (02:58 +0000)
committercmzmasek@gmail.com <cmzmasek@gmail.com@ca865154-3058-d1c3-3e42-d8f55a55bdbd>
Wed, 7 May 2014 02:58:20 +0000 (02:58 +0000)
forester/java/src/org/forester/application/msa_compactor.java
forester/java/src/org/forester/msa_compactor/MsaCompactor.java

index 7539b0e..316daa4 100644 (file)
@@ -255,6 +255,12 @@ public class msa_compactor {
                                                      + STEP_FOR_DIAGNOSTICS_OPTION + " instead" );
                 }
             }
+            if ( perform_phylogenetic_inference ) {
+                if ( step_for_diagnostics != 1 ) {
+                    ForesterUtil.fatalError( PRG_NAME,
+                                             "step for diagnostics reports needs to be set to 1 for tree calculation" );
+                }
+            }
             ForesterUtil.printProgramInformation( PRG_NAME,
                                                   PRG_DESC,
                                                   PRG_VERSION,
index 0b7f8ed..4411fd2 100644 (file)
@@ -74,17 +74,18 @@ public class MsaCompactor {
     final private static NumberFormat NF_3                      = new DecimalFormat( "#.###" );
     final private static NumberFormat NF_4                      = new DecimalFormat( "#.####" );
     private double                    _gap_ratio                = -1;
+    //
+    private String                    _infile_name              = null;
     private final short               _longest_id_length;
     //
     private String                    _maffts_opts              = "--auto";
     private int                       _min_length               = -1;
-    //
-    private String                    _infile_name              = null;
     private DeleteableMsa             _msa                      = null;
     private boolean                   _norm                     = true;
     private File                      _out_file_base            = null;
     private MSA_FORMAT                _output_format            = MSA_FORMAT.FASTA;
     private String                    _path_to_mafft            = null;
+    private boolean                   _phylogentic_inference    = false;
     //
     private boolean                   _realign                  = false;
     private final SortedSet<String>   _removed_seq_ids;
@@ -93,7 +94,6 @@ public class MsaCompactor {
     private boolean                   _report_aln_mean_identity = false;
     private int                       _step                     = -1;
     private int                       _step_for_diagnostics     = -1;
-    private boolean                   _phylogentic_inference    = false;
     static {
         NF_4.setRoundingMode( RoundingMode.HALF_UP );
         NF_3.setRoundingMode( RoundingMode.HALF_UP );
@@ -106,6 +106,29 @@ public class MsaCompactor {
         _removed_seqs = new ArrayList<Sequence>();
     }
 
+    public final Phylogeny calcTree() {
+        final Phylogeny phy = inferNJphylogeny( PWD_DISTANCE_METHOD.KIMURA_DISTANCE, _msa, false, "" );
+        PhylogenyMethods.midpointRoot( phy );
+        PhylogenyMethods.orderAppearance( phy.getRoot(), true, true, DESCENDANT_SORT_PRIORITY.NODE_NAME );
+        final boolean x = PhylogenyMethods.extractFastaInformation( phy );
+        if ( !x ) {
+            final PhylogenyNodeIterator it = phy.iteratorExternalForward();
+            while ( it.hasNext() ) {
+                final PhylogenyNode n = it.next();
+                final String name = n.getName().trim();
+                if ( !ForesterUtil.isEmpty( name ) ) {
+                    try {
+                        ParserUtils.extractTaxonomyDataFromNodeName( n, TAXONOMY_EXTRACTION.AGGRESSIVE );
+                    }
+                    catch ( final PhyloXmlDataFormatException e ) {
+                        // Ignore.
+                    }
+                }
+            }
+        }
+        return phy;
+    }
+
     public final List<MsaProperties> chart( final int step, final boolean realign, final boolean norm )
             throws IOException, InterruptedException {
         final GapContribution stats[] = calcGapContribtionsStats( norm );
@@ -114,6 +137,12 @@ public class MsaCompactor {
         for( final GapContribution gap_gontribution : stats ) {
             to_remove_ids.add( gap_gontribution.getId() );
         }
+        Phylogeny phy = null;
+        if ( _phylogentic_inference ) {
+            System.out.println( "calculating phylogentic tree..." );
+            System.out.println();
+            phy = calcTree();
+        }
         if ( !_realign ) {
             _step = -1;
         }
@@ -123,14 +152,8 @@ public class MsaCompactor {
         }
         MsaProperties msa_prop = new MsaProperties( _msa, "", _report_aln_mean_identity );
         msa_props.add( msa_prop );
-        Phylogeny phy = null;
-        if ( _phylogentic_inference ) {
-            System.out.println( "calculating phylogentic tree..." );
-            System.out.println();
-            phy = calcTree();
-        }
         printTableHeader();
-        printMsaProperties( "", msa_prop );
+        printMsaProperties( msa_prop );
         System.out.println();
         int i = 0;
         while ( _msa.getNumberOfSequences() > x ) {
@@ -141,7 +164,7 @@ public class MsaCompactor {
                 realignWithMafft();
                 msa_prop = new MsaProperties( _msa, id, _report_aln_mean_identity );
                 msa_props.add( msa_prop );
-                printMsaProperties( id, msa_prop );
+                printMsaProperties( msa_prop );
                 System.out.print( "(realigned)" );
                 System.out.println();
             }
@@ -149,39 +172,102 @@ public class MsaCompactor {
                 removeGapColumns();
                 msa_prop = new MsaProperties( _msa, id, _report_aln_mean_identity );
                 msa_props.add( msa_prop );
-                printMsaProperties( id, msa_prop );
+                printMsaProperties( msa_prop );
                 System.out.println();
             }
             ++i;
         }
         if ( _phylogentic_inference ) {
-            final Phylogeny p2 = phy.copy();
-            decorateTree( p2, to_remove_ids );
-            decorateTree2( phy, msa_props );
-            displayTree( p2 );
+            decorateTree( phy, msa_props, true );
             displayTree( phy );
         }
         return msa_props;
     }
 
+    public final void decorateTree( final Phylogeny phy, final List<MsaProperties> msa_props, final boolean chart_only ) {
+        final BasicDescriptiveStatistics length_stats = new BasicDescriptiveStatistics();
+        for( int i = 0; i < msa_props.size(); ++i ) {
+            final MsaProperties msa_prop = msa_props.get( i );
+            final String id = msa_prop.getRemovedSeq();
+            if ( !ForesterUtil.isEmpty( id ) ) {
+                length_stats.addValue( msa_prop.getLength() );
+            }
+        }
+        final double mean = length_stats.arithmeticMean();
+        final double min = length_stats.getMin();
+        final double max = length_stats.getMax();
+        final Color min_color = new Color( 0, 255, 0 );
+        final Color max_color = new Color( 255, 0, 0 );
+        final Color mean_color = new Color( 255, 255, 0 );
+        final PhylogenyNodeIterator it = phy.iteratorExternalForward();
+        if ( chart_only ) {
+            while ( it.hasNext() ) {
+                final NodeVisualData vis = new NodeVisualData();
+                vis.setFillType( NodeFill.SOLID );
+                vis.setShape( NodeShape.RECTANGLE );
+                vis.setNodeColor( min_color );
+                it.next().getNodeData().setNodeVisualData( vis );
+            }
+        }
+        for( int i = 0; i < msa_props.size(); ++i ) {
+            final MsaProperties msa_prop = msa_props.get( i );
+            final String id = msa_prop.getRemovedSeq();
+            if ( !ForesterUtil.isEmpty( id ) ) {
+                final PhylogenyNode n = phy.getNode( id );
+                n.setName( n.getName() + " [" + i + "]" );
+                if ( !chart_only ) {
+                    final NodeVisualData vis = new NodeVisualData();
+                    vis.setFillType( NodeFill.SOLID );
+                    vis.setShape( NodeShape.RECTANGLE );
+                    vis.setNodeColor( ForesterUtil.calcColor( msa_prop.getLength(), min, max, mean_color, max_color ) );
+                    n.getNodeData().setNodeVisualData( vis );
+                }
+                else {
+                    n.getNodeData()
+                            .getNodeVisualData()
+                            .setNodeColor( ForesterUtil.calcColor( msa_prop.getLength(),
+                                                                   min,
+                                                                   max,
+                                                                   mean,
+                                                                   min_color,
+                                                                   max_color,
+                                                                   mean_color ) );
+                }
+            }
+        }
+    }
+
     final public void deleteGapColumns( final double max_allowed_gap_ratio ) {
         _msa.deleteGapColumns( max_allowed_gap_ratio );
     }
 
-    final public Msa getMsa() {
-        return _msa;
+    public final void displayTree( final Phylogeny phy ) {
+        final Configuration config = new Configuration();
+        config.setDisplayAsPhylogram( true );
+        config.setUseStyle( true );
+        config.setDisplayTaxonomyCode( false );
+        config.setDisplayTaxonomyCommonNames( false );
+        config.setDisplayTaxonomyScientificNames( false );
+        config.setDisplaySequenceNames( false );
+        config.setDisplaySequenceSymbols( false );
+        config.setDisplayGeneNames( false );
+        config.setShowScale( true );
+        config.setAddTaxonomyImagesCB( false );
+        config.setBaseFontSize( 9 );
+        config.setBaseFontFamilyName( "Arial" );
+        Archaeopteryx.createApplication( phy, config, _infile_name );
     }
 
-    final public SortedSet<String> getRemovedSeqIds() {
-        return _removed_seq_ids;
+    final public Msa getMsa() {
+        return _msa;
     }
 
     public final void removeSequencesByMinimalLength( final int min_effective_length ) {
-        printMsaProperties( "", new MsaProperties( _msa, "", _report_aln_mean_identity ) );
+        printMsaProperties( new MsaProperties( _msa, "", _report_aln_mean_identity ) );
         System.out.println();
         _msa = DeleteableMsa.createInstance( MsaMethods.removeSequencesByMinimalLength( _msa, min_effective_length ) );
         removeGapColumns();
-        printMsaProperties( "", new MsaProperties( _msa, "", _report_aln_mean_identity ) );
+        printMsaProperties( new MsaProperties( _msa, "", _report_aln_mean_identity ) );
         System.out.println();
     }
 
@@ -193,10 +279,16 @@ public class MsaCompactor {
         for( final GapContribution gap_gontribution : stats ) {
             to_remove_ids.add( gap_gontribution.getId() );
         }
+        Phylogeny phy = null;
+        if ( _phylogentic_inference ) {
+            System.out.println( "calculating phylogentic tree..." );
+            System.out.println();
+            phy = calcTree();
+        }
         printTableHeader();
         MsaProperties msa_prop = new MsaProperties( _msa, "", _report_aln_mean_identity );
         msa_props.add( msa_prop );
-        printMsaProperties( "", msa_prop );
+        printMsaProperties( msa_prop );
         System.out.println();
         int i = 0;
         while ( MsaMethods.calcGapRatio( _msa ) > mean_gapiness ) {
@@ -213,7 +305,7 @@ public class MsaCompactor {
             else if ( isPrintMsaStats( i ) ) {
                 msa_prop = new MsaProperties( _msa, id, _report_aln_mean_identity );
                 msa_props.add( msa_prop );
-                printMsaProperties( id, msa_prop );
+                printMsaProperties( msa_prop );
                 System.out.println();
             }
             ++i;
@@ -223,6 +315,10 @@ public class MsaCompactor {
             System.out.println();
             System.out.println( msg );
         }
+        if ( _phylogentic_inference ) {
+            decorateTree( phy, msa_props, false );
+            displayTree( phy );
+        }
         return msa_props;
     }
 
@@ -233,10 +329,16 @@ public class MsaCompactor {
         for( final GapContribution gap_gontribution : stats ) {
             to_remove_ids.add( gap_gontribution.getId() );
         }
+        Phylogeny phy = null;
+        if ( _phylogentic_inference ) {
+            System.out.println( "calculating phylogentic tree..." );
+            System.out.println();
+            phy = calcTree();
+        }
         printTableHeader();
         MsaProperties msa_prop = new MsaProperties( _msa, "", _report_aln_mean_identity );
         msa_props.add( msa_prop );
-        printMsaProperties( "", msa_prop );
+        printMsaProperties( msa_prop );
         System.out.println();
         int i = 0;
         while ( _msa.getLength() > length ) {
@@ -252,7 +354,7 @@ public class MsaCompactor {
             }
             else if ( isPrintMsaStats( i ) ) {
                 msa_prop = new MsaProperties( _msa, id, _report_aln_mean_identity );
-                printMsaProperties( id, msa_prop );
+                printMsaProperties( msa_prop );
                 msa_props.add( msa_prop );
                 System.out.println();
             }
@@ -263,6 +365,10 @@ public class MsaCompactor {
             System.out.println();
             System.out.println( msg );
         }
+        if ( _phylogentic_inference ) {
+            decorateTree( phy, msa_props, false );
+            displayTree( phy );
+        }
         return msa_props;
     }
 
@@ -273,12 +379,17 @@ public class MsaCompactor {
         final List<MsaProperties> msa_props = new ArrayList<MsaProperties>();
         for( int j = 0; j < to_remove; ++j ) {
             to_remove_ids.add( stats[ j ].getId() );
-            _removed_seq_ids.add( stats[ j ].getId() );
+        }
+        Phylogeny phy = null;
+        if ( _phylogentic_inference ) {
+            System.out.println( "calculating phylogentic tree..." );
+            System.out.println();
+            phy = calcTree();
         }
         printTableHeader();
         MsaProperties msa_prop = new MsaProperties( _msa, "", _report_aln_mean_identity );
         msa_props.add( msa_prop );
-        printMsaProperties( "", msa_prop );
+        printMsaProperties( msa_prop );
         System.out.println();
         for( int i = 0; i < to_remove_ids.size(); ++i ) {
             final String id = to_remove_ids.get( i );
@@ -294,7 +405,7 @@ public class MsaCompactor {
             else if ( isPrintMsaStats( i ) ) {
                 msa_prop = new MsaProperties( _msa, id, _report_aln_mean_identity );
                 msa_props.add( msa_prop );
-                printMsaProperties( id, msa_prop );
+                printMsaProperties( msa_prop );
                 System.out.println();
             }
         }
@@ -303,6 +414,10 @@ public class MsaCompactor {
             System.out.println();
             System.out.println( msg );
         }
+        if ( _phylogentic_inference ) {
+            decorateTree( phy, msa_props, false );
+            displayTree( phy );
+        }
         return msa_props;
     }
 
@@ -310,6 +425,10 @@ public class MsaCompactor {
         _gap_ratio = gap_ratio;
     }
 
+    public void setInfileName( final String infile_name ) {
+        _infile_name = infile_name;
+    }
+
     public final void setMafftOptions( final String maffts_opts ) {
         _maffts_opts = maffts_opts;
     }
@@ -334,6 +453,10 @@ public class MsaCompactor {
         _path_to_mafft = path_to_mafft;
     }
 
+    public void setPeformPhylogenticInference( final boolean phylogentic_inference ) {
+        _phylogentic_inference = phylogentic_inference;
+    }
+
     public final void setRealign( final boolean realign ) {
         _realign = realign;
     }
@@ -512,106 +635,9 @@ public class MsaCompactor {
         return master_phy;
     }
 
-    public final Phylogeny calcTree() {
-        final Phylogeny phy = inferNJphylogeny( PWD_DISTANCE_METHOD.KIMURA_DISTANCE, _msa, false, "" );
-        PhylogenyMethods.midpointRoot( phy );
-        PhylogenyMethods.orderAppearance( phy.getRoot(), true, true, DESCENDANT_SORT_PRIORITY.NODE_NAME );
-        final boolean x = PhylogenyMethods.extractFastaInformation( phy );
-        if ( !x ) {
-            final PhylogenyNodeIterator it = phy.iteratorExternalForward();
-            while ( it.hasNext() ) {
-                final PhylogenyNode n = it.next();
-                final String name = n.getName().trim();
-                if ( !ForesterUtil.isEmpty( name ) ) {
-                    try {
-                        ParserUtils.extractTaxonomyDataFromNodeName( n, TAXONOMY_EXTRACTION.AGGRESSIVE );
-                    }
-                    catch ( final PhyloXmlDataFormatException e ) {
-                        // Ignore.
-                    }
-                }
-            }
-        }
-        return phy;
-    }
-
-    public final void decorateTree( final Phylogeny phy, final List<String> to_remove_ids ) {
-        for( int i = 0; i < to_remove_ids.size(); ++i ) {
-            final String id = to_remove_ids.get( i );
-            final PhylogenyNode n = phy.getNode( id );
-            n.setName( n.getName() + " [" + ( i + 1 ) + "]" );
-            final NodeVisualData vis = new NodeVisualData();
-            vis.setFillType( NodeFill.SOLID );
-            vis.setShape( NodeShape.RECTANGLE );
-            vis.setSize( 6 );
-            vis.setNodeColor( new Color( i > 255 ? 0 : 255 - i, 0, 0 ) );
-            n.getNodeData().setNodeVisualData( vis );
-        }
-    }
-
-    public final void decorateTree2( final Phylogeny phy, final List<MsaProperties> msa_props ) {
-        final BasicDescriptiveStatistics length_stats = new BasicDescriptiveStatistics();
-        for( int i = 0; i < msa_props.size(); ++i ) {
-            final MsaProperties msa_prop = msa_props.get( i );
-            final String id = msa_prop.getRemovedSeq();
-            if ( !ForesterUtil.isEmpty( id ) ) {
-                length_stats.addValue( msa_prop.getLength() );
-            }
-        }
-        final double mean = length_stats.arithmeticMean();
-        final double min = length_stats.getMin();
-        final double max = length_stats.getMax();
-        final Color min_color = new Color( 0, 255, 0 );
-        final Color max_color = new Color( 255, 0, 0 );
-        final Color mean_color = new Color( 255, 255, 0 );
-        final PhylogenyNodeIterator it = phy.iteratorExternalForward();
-        while ( it.hasNext() ) {
-            final NodeVisualData vis = new NodeVisualData();
-            vis.setFillType( NodeFill.SOLID );
-            vis.setShape( NodeShape.RECTANGLE );
-            vis.setSize( 6 );
-            vis.setNodeColor( min_color );
-            it.next().getNodeData().setNodeVisualData( vis );
-        }
-        for( int i = 0; i < msa_props.size(); ++i ) {
-            final MsaProperties msa_prop = msa_props.get( i );
-            final String id = msa_prop.getRemovedSeq();
-            if ( !ForesterUtil.isEmpty( id ) ) {
-                final PhylogenyNode n = phy.getNode( id );
-                n.setName( n.getName() + " [" + i + "]" );
-                n.getNodeData()
-                        .getNodeVisualData()
-                        .setNodeColor( ForesterUtil.calcColor( msa_prop.getLength(),
-                                                               min,
-                                                               max,
-                                                               mean,
-                                                               min_color,
-                                                               max_color,
-                                                               mean_color ) );
-            }
-        }
-    }
-
-    public final void displayTree( final Phylogeny phy ) {
-        final Configuration config = new Configuration();
-        config.setDisplayAsPhylogram( true );
-        config.setUseStyle( true );
-        config.setDisplayTaxonomyCode( false );
-        config.setDisplayTaxonomyCommonNames( false );
-        config.setDisplayTaxonomyScientificNames( false );
-        config.setDisplaySequenceNames( false );
-        config.setDisplaySequenceSymbols( false );
-        config.setDisplayGeneNames( false );
-        config.setShowScale( true );
-        config.setAddTaxonomyImagesCB( false );
-        config.setBaseFontSize( 9 );
-        config.setBaseFontFamilyName( "Arial" );
-        Archaeopteryx.createApplication( phy, config, _infile_name );
-    }
-
-    private final void printMsaProperties( final String id, final MsaProperties msa_properties ) {
+    private final void printMsaProperties( final MsaProperties msa_properties ) {
         if ( ( _step == 1 ) || ( _step_for_diagnostics == 1 ) ) {
-            System.out.print( ForesterUtil.pad( id, _longest_id_length, ' ', false ) );
+            System.out.print( ForesterUtil.pad( msa_properties.getRemovedSeq(), _longest_id_length, ' ', false ) );
             System.out.print( "\t" );
         }
         System.out.print( msaPropertiesAsSB( msa_properties ) );
@@ -624,7 +650,7 @@ public class MsaCompactor {
             realignWithMafft();
         }
         final MsaProperties msa_prop = new MsaProperties( _msa, id, _report_aln_mean_identity );
-        printMsaProperties( id, msa_prop );
+        printMsaProperties( msa_prop );
         final String s = writeOutfile();
         System.out.print( "-> " + s + ( realign ? "\t(realigned)" : "" ) );
         return msa_prop;
@@ -704,12 +730,4 @@ public class MsaCompactor {
         msa.write( w, format );
         w.close();
     }
-
-    public void setPeformPhylogenticInference( final boolean phylogentic_inference ) {
-        _phylogentic_inference = phylogentic_inference;
-    }
-
-    public void setInfileName( final String infile_name ) {
-        _infile_name = infile_name;
-    }
 }