in progress
[jalview.git] / forester / java / src / org / forester / msa_compactor / MsaCompactor.java
index 2a5c5b1..8a13b5c 100644 (file)
@@ -1,6 +1,30 @@
+// $Id:
+// FORESTER -- software libraries and applications
+// for evolutionary biology research and applications.
+//
+// Copyright (C) 2014 Christian M. Zmasek
+// Copyright (C) 2014 Sanford-Burnham Medical Research Institute
+// All rights reserved
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
+//
+// WWW: https://sites.google.com/site/cmzmasek/home/software/forester
 
 package org.forester.msa_compactor;
 
+import java.awt.Color;
 import java.io.File;
 import java.io.IOException;
 import java.io.Writer;
@@ -13,12 +37,19 @@ import java.util.List;
 import java.util.SortedSet;
 import java.util.TreeSet;
 
+import org.forester.archaeopteryx.Archaeopteryx;
+import org.forester.archaeopteryx.Configuration;
 import org.forester.evoinference.distance.NeighborJoiningF;
 import org.forester.evoinference.distance.PairwiseDistanceCalculator;
 import org.forester.evoinference.distance.PairwiseDistanceCalculator.PWD_DISTANCE_METHOD;
 import org.forester.evoinference.matrix.distance.BasicSymmetricalDistanceMatrix;
 import org.forester.evoinference.tools.BootstrapResampler;
-import org.forester.msa.BasicMsa;
+import org.forester.io.parsers.nhx.NHXParser.TAXONOMY_EXTRACTION;
+import org.forester.io.parsers.phyloxml.PhyloXmlDataFormatException;
+import org.forester.io.parsers.util.ParserUtils;
+import org.forester.io.writers.SequenceWriter;
+import org.forester.io.writers.SequenceWriter.SEQ_FORMAT;
+import org.forester.msa.DeleteableMsa;
 import org.forester.msa.Mafft;
 import org.forester.msa.Msa;
 import org.forester.msa.Msa.MSA_FORMAT;
@@ -27,7 +58,13 @@ import org.forester.msa.MsaMethods;
 import org.forester.msa.ResampleableMsa;
 import org.forester.phylogeny.Phylogeny;
 import org.forester.phylogeny.PhylogenyMethods;
-import org.forester.sequence.Sequence;
+import org.forester.phylogeny.PhylogenyMethods.DESCENDANT_SORT_PRIORITY;
+import org.forester.phylogeny.PhylogenyNode;
+import org.forester.phylogeny.data.NodeVisualData;
+import org.forester.phylogeny.data.NodeVisualData.NodeFill;
+import org.forester.phylogeny.data.NodeVisualData.NodeShape;
+import org.forester.phylogeny.iterators.PhylogenyNodeIterator;
+import org.forester.sequence.MolecularSequence;
 import org.forester.tools.ConfidenceAssessor;
 import org.forester.util.BasicDescriptiveStatistics;
 import org.forester.util.DescriptiveStatistics;
@@ -35,44 +72,489 @@ import org.forester.util.ForesterUtil;
 
 public class MsaCompactor {
 
-    final private static NumberFormat NF_3    = new DecimalFormat( "#.###" );
-    final private static NumberFormat NF_4    = new DecimalFormat( "#.####" );
-    private static final boolean      VERBOSE = false;
-    private Msa                       _msa;
-    private File                      _out_file_base;
-    private String                    _path_to_mafft;
-    private final SortedSet<String>   _removed_seq_ids;
+    final private static NumberFormat          NF_1                       = new DecimalFormat( "0.#" );
+    final private static NumberFormat          NF_3                       = new DecimalFormat( "0.###" );
+    final private static NumberFormat          NF_4                       = new DecimalFormat( "0.####" );
+    private boolean                            _calculate_shannon_entropy = false;
+    //
+    private String                             _infile_name               = null;
+    private final short                        _longest_id_length;
+    //
+    private String                             _maffts_opts               = "--auto";
+    private DeleteableMsa                      _msa                       = null;
+    private boolean                            _normalize_for_effective_seq_length                      = 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;
+    private final ArrayList<MolecularSequence> _removed_seqs;
+    private File                               _removed_seqs_out_base     = null;
+    private int                                _step                      = -1;
+    private int                                _step_for_diagnostics      = -1;
     static {
+        NF_1.setRoundingMode( RoundingMode.HALF_UP );
         NF_4.setRoundingMode( RoundingMode.HALF_UP );
         NF_3.setRoundingMode( RoundingMode.HALF_UP );
     }
 
-    private MsaCompactor( final Msa msa ) {
+    public MsaCompactor( final DeleteableMsa msa ) {
         _msa = msa;
         _removed_seq_ids = new TreeSet<String>();
+        _longest_id_length = _msa.determineMaxIdLength();
+        _removed_seqs = new ArrayList<MolecularSequence>();
+    }
+
+    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 normalize_for_effective_seq_length )
+            throws IOException, InterruptedException {
+        final GapContribution stats[] = calcGapContribtionsStats( normalize_for_effective_seq_length );
+        final List<String> to_remove_ids = new ArrayList<String>();
+        final List<MsaProperties> msa_props = new ArrayList<MsaProperties>();
+        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();
+            addSeqs2Tree( _msa, phy );
+        }
+        if ( !_realign ) {
+            _step = -1;
+        }
+        int x = ForesterUtil.roundToInt( _msa.getNumberOfSequences() / 10.0 );
+        if ( x < 2 ) {
+            x = 2;
+        }
+        MsaProperties msa_prop = new MsaProperties( _msa, "", _calculate_shannon_entropy );
+        msa_props.add( msa_prop );
+        printTableHeader();
+        printMsaProperties( msa_prop );
+        System.out.println();
+        int i = 0;
+        while ( _msa.getNumberOfSequences() > x ) {
+            final String id = to_remove_ids.get( i );
+            _msa.deleteRow( id, false );
+            if ( realign && isPrintMsaStatsWriteOutfileAndRealign( i ) ) {
+                removeGapColumns();
+                realignWithMafft();
+                msa_prop = new MsaProperties( _msa, id, _calculate_shannon_entropy );
+                msa_props.add( msa_prop );
+                printMsaProperties( msa_prop );
+                System.out.print( "(realigned)" );
+                System.out.println();
+            }
+            else if ( isPrintMsaStats( i ) ) {
+                removeGapColumns();
+                msa_prop = new MsaProperties( _msa, id, _calculate_shannon_entropy );
+                msa_props.add( msa_prop );
+                printMsaProperties( msa_prop );
+                System.out.println();
+            }
+            ++i;
+        }
+        
+        if ( _phylogentic_inference ) {
+            decorateTree( phy, msa_props, true );
+            displayTree( phy );
+        }
+        return msa_props;
+    }
+
+    private final static void addSeqs2Tree( final Msa msa, final Phylogeny phy ) {
+        for( int i = 0; i < msa.getNumberOfSequences(); ++i ) {
+            final MolecularSequence seq = msa.getSequence( i );
+            final String seq_name = seq.getIdentifier();
+            final PhylogenyNode n = phy.getNode( seq_name );
+            if ( !n.getNodeData().isHasSequence() ) {
+                n.getNodeData().addSequence( new org.forester.phylogeny.data.Sequence() );
+            }
+            else {
+                throw new IllegalArgumentException( "this should not have happened" );
+            }
+            n.getNodeData().getSequence().setMolecularSequence( seq.getMolecularSequenceAsString() );
+            n.getNodeData().getSequence().setMolecularSequenceAligned( true );
+            n.getNodeData().getSequence().setName( seq_name );
+        }
+    }
+
+    private final static 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 );
+    }
+
+    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.setDisplayMultipleSequenceAlignment( true );
+        config.setShowScale( true );
+        config.setAddTaxonomyImagesCB( false );
+        config.setBaseFontSize( 9 );
+        config.setBaseFontFamilyName( "Arial" );
+        Archaeopteryx.createApplication( phy, config, _infile_name );
     }
 
     final public Msa getMsa() {
         return _msa;
     }
 
-    final public SortedSet<String> getRemovedSeqIds() {
-        return _removed_seq_ids;
+    public final void removeSequencesByMinimalLength( final int min_effective_length ) throws IOException {
+        _msa = DeleteableMsa.createInstance( MsaMethods.removeSequencesByMinimalLength( _msa, min_effective_length ) );
+        removeGapColumns();
+        final String s = writeOutfile();
+        final DescriptiveStatistics msa_stats = MsaMethods.calculateEffectiveLengthStatistics( _msa );
+        System.out.println( "Output MSA                           : " + s );
+        System.out.println( "  MSA length                         : " + _msa.getLength() );
+        System.out.println( "  Number of sequences                : " + _msa.getNumberOfSequences() );
+        System.out.println( "  Median sequence length             : " + NF_1.format( msa_stats.median() ) );
+        System.out.println( "  Mean sequence length               : " + NF_1.format( msa_stats.arithmeticMean() ) );
+        System.out.println( "  Max sequence length                : " + ( ( int ) msa_stats.getMax() ) );
+        System.out.println( "  Min sequence length                : " + ( ( int ) msa_stats.getMin() ) );
+        System.out.println( "  Gap ratio                          : " + NF_4.format( MsaMethods.calcGapRatio( _msa ) ) );
+        System.out.println( "  Normalized Shannon Entropy (entn21): "
+                + NF_4.format( MsaMethods.calcNormalizedShannonsEntropy( 21, _msa ) ) );
+        System.out.println();
+    }
+
+    public final List<MsaProperties> removeViaGapAverage( final double mean_gapiness ) throws IOException,
+    InterruptedException {
+        final GapContribution stats[] = calcGapContribtionsStats( _normalize_for_effective_seq_length );
+        final List<String> to_remove_ids = new ArrayList<String>();
+        final List<MsaProperties> msa_props = new ArrayList<MsaProperties>();
+        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();
+            addSeqs2Tree( _msa, phy );
+        }
+        printTableHeader();
+        MsaProperties msa_prop = new MsaProperties( _msa, "", _calculate_shannon_entropy );
+        msa_props.add( msa_prop );
+        printMsaProperties( msa_prop );
+        System.out.println();
+        int i = 0;
+        while ( MsaMethods.calcGapRatio( _msa ) > mean_gapiness ) {
+            final String id = to_remove_ids.get( i );
+            _removed_seq_ids.add( id );
+            final MolecularSequence deleted = _msa.deleteRow( id, true );
+            _removed_seqs.add( deleted );
+            removeGapColumns();
+            if ( isPrintMsaStatsWriteOutfileAndRealign( i ) || ( MsaMethods.calcGapRatio( _msa ) <= mean_gapiness ) ) {
+                msa_prop = printMsaStatsWriteOutfileAndRealign( _realign, id );
+                msa_props.add( msa_prop );
+                System.out.println();
+            }
+            else if ( isPrintMsaStats( i ) ) {
+                msa_prop = new MsaProperties( _msa, id, _calculate_shannon_entropy );
+                msa_props.add( msa_prop );
+                printMsaProperties( msa_prop );
+                System.out.println();
+            }
+            ++i;
+        }
+        if ( _removed_seqs_out_base != null ) {
+            final String msg = writeAndAlignRemovedSeqs();
+            System.out.println();
+            System.out.println( msg );
+        }
+        if ( _phylogentic_inference ) {
+            decorateTree( phy, msa_props, false );
+            displayTree( phy );
+            System.out.println( "calculating phylogentic tree..." );
+            System.out.println();
+            final Phylogeny phy2 = calcTree();
+            addSeqs2Tree( _msa, phy2 );
+            displayTree( phy2 );
+        }   
+      
+       
+        return msa_props;
+    }
+
+    public List<MsaProperties> removeViaLength( final int length ) throws IOException, InterruptedException {
+        final GapContribution stats[] = calcGapContribtionsStats( _normalize_for_effective_seq_length );
+        final List<String> to_remove_ids = new ArrayList<String>();
+        final List<MsaProperties> msa_props = new ArrayList<MsaProperties>();
+        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();
+            addSeqs2Tree( _msa, phy );
+        }
+        printTableHeader();
+        MsaProperties msa_prop = new MsaProperties( _msa, "", _calculate_shannon_entropy );
+        msa_props.add( msa_prop );
+        printMsaProperties( msa_prop );
+        System.out.println();
+        int i = 0;
+        while ( _msa.getLength() > length ) {
+            final String id = to_remove_ids.get( i );
+            _removed_seq_ids.add( id );
+            final MolecularSequence deleted = _msa.deleteRow( id, true );
+            _removed_seqs.add( deleted );
+            removeGapColumns();
+            if ( isPrintMsaStatsWriteOutfileAndRealign( i ) || ( _msa.getLength() <= length ) ) {
+                msa_prop = printMsaStatsWriteOutfileAndRealign( _realign, id );
+                msa_props.add( msa_prop );
+                System.out.println();
+            }
+            else if ( isPrintMsaStats( i ) ) {
+                msa_prop = new MsaProperties( _msa, id, _calculate_shannon_entropy );
+                printMsaProperties( msa_prop );
+                msa_props.add( msa_prop );
+                System.out.println();
+            }
+            ++i;
+        }
+        if ( _removed_seqs_out_base != null ) {
+            final String msg = writeAndAlignRemovedSeqs();
+            System.out.println();
+            System.out.println( msg );
+        }
+        if ( _phylogentic_inference ) {
+            decorateTree( phy, msa_props, false );
+            displayTree( phy );
+            System.out.println( "calculating phylogentic tree..." );
+            System.out.println();
+            final Phylogeny phy2 = calcTree();
+            addSeqs2Tree( _msa, phy2 );
+            displayTree( phy2 );
+        }   
+       
+        return msa_props;
+    }
+
+    public final List<MsaProperties> removeWorstOffenders( final int to_remove ) throws IOException,
+    InterruptedException {
+        final GapContribution stats[] = calcGapContribtionsStats( _normalize_for_effective_seq_length );
+        final List<String> to_remove_ids = new ArrayList<String>();
+        final List<MsaProperties> msa_props = new ArrayList<MsaProperties>();
+        for( int j = 0; j < to_remove; ++j ) {
+            to_remove_ids.add( stats[ j ].getId() );
+        }
+        Phylogeny phy = null;
+        if ( _phylogentic_inference ) {
+            System.out.println( "calculating phylogentic tree..." );
+            System.out.println();
+            phy = calcTree();
+            addSeqs2Tree( _msa, phy );
+        }
+        printTableHeader();
+        MsaProperties msa_prop = new MsaProperties( _msa, "", _calculate_shannon_entropy );
+        msa_props.add( 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 );
+            _removed_seq_ids.add( id );
+            final MolecularSequence deleted = _msa.deleteRow( id, true );
+            _removed_seqs.add( deleted );
+            removeGapColumns();
+            if ( isPrintMsaStatsWriteOutfileAndRealign( i ) || ( i == ( to_remove_ids.size() - 1 ) ) ) {
+                msa_prop = printMsaStatsWriteOutfileAndRealign( _realign, id );
+                msa_props.add( msa_prop );
+                System.out.println();
+            }
+            else if ( isPrintMsaStats( i ) ) {
+                msa_prop = new MsaProperties( _msa, id, _calculate_shannon_entropy );
+                msa_props.add( msa_prop );
+                printMsaProperties( msa_prop );
+                System.out.println();
+            }
+        }
+        if ( _removed_seqs_out_base != null ) {
+            final String msg = writeAndAlignRemovedSeqs();
+            System.out.println();
+            System.out.println( msg );
+        }
+        if ( _phylogentic_inference ) {
+            decorateTree( phy, msa_props, false );
+            displayTree( phy );
+            System.out.println( "calculating phylogentic tree..." );
+            System.out.println();
+            final Phylogeny phy2 = calcTree();
+            addSeqs2Tree( _msa, phy2 );
+            displayTree( phy2 );
+        }   
+       
+        return msa_props;
+    }
+
+    public final void setCalculateNormalizedShannonEntropy( final boolean calculate_shannon_entropy ) {
+        _calculate_shannon_entropy = calculate_shannon_entropy;
+    }
+
+    public void setInfileName( final String infile_name ) {
+        _infile_name = infile_name;
+    }
+
+    public final void setMafftOptions( final String maffts_opts ) {
+        _maffts_opts = maffts_opts;
+    }
+
+    public final void setNorm( final boolean normalize_for_effective_seq_length ) {
+        _normalize_for_effective_seq_length = normalize_for_effective_seq_length;
     }
 
     final public void setOutFileBase( final File out_file_base ) {
         _out_file_base = out_file_base;
     }
 
-    final public String writeMsa( final File outfile, final MSA_FORMAT format, final String suffix ) throws IOException {
+    public final void setOutputFormat( final MSA_FORMAT output_format ) {
+        _output_format = output_format;
+    }
+
+    public void setPathToMafft( final String path_to_mafft ) {
+        _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;
+    }
+
+    public final void setRemovedSeqsOutBase( final File removed_seqs_out_base ) {
+        _removed_seqs_out_base = removed_seqs_out_base;
+    }
+
+    public final void setStep( final int step ) {
+        _step = step;
+    }
+
+    public final void setStepForDiagnostics( final int step_for_diagnostics ) {
+        _step_for_diagnostics = step_for_diagnostics;
+    }
+
+    final public String writeAndAlignRemovedSeqs() throws IOException, InterruptedException {
+        final StringBuilder msg = new StringBuilder();
+        final String n = _removed_seqs_out_base + "_" + _removed_seqs.size() + ".fasta";
+        SequenceWriter.writeSeqs( _removed_seqs, new File( n ), SEQ_FORMAT.FASTA, 100 );
+        msg.append( "wrote " + _removed_seqs.size() + " removed sequences to " + "\"" + n + "\"" );
+        if ( _realign ) {
+            final MsaInferrer mafft = Mafft.createInstance( _path_to_mafft );
+            final List<String> opts = new ArrayList<String>();
+            for( final String o : _maffts_opts.split( "\\s" ) ) {
+                opts.add( o );
+            }
+            final Msa removed_msa = mafft.infer( _removed_seqs, opts );
+            final Double gr = MsaMethods.calcGapRatio( removed_msa );
+            String s = _removed_seqs_out_base + "_" + removed_msa.getNumberOfSequences() + "_"
+                    + removed_msa.getLength() + "_" + ForesterUtil.roundToInt( gr * 100 );
+            final String suffix = obtainSuffix();
+            s += suffix;
+            writeMsa( removed_msa, s, _output_format );
+            msg.append( ", and as MSA of length " + removed_msa.getLength() + " to \"" + s + "\"" );
+        }
+        return msg.toString();
+    }
+
+    final public String writeMsa( final File outfile ) throws IOException {
         final Double gr = MsaMethods.calcGapRatio( _msa );
         final String s = outfile + "_" + _msa.getNumberOfSequences() + "_" + _msa.getLength() + "_"
                 + ForesterUtil.roundToInt( gr * 100 );
-        writeMsa( s + suffix, format );
+        writeMsa( _msa, s + obtainSuffix(), _output_format );
         return s;
     }
 
-    final int calcNonGapResidues( final Sequence seq ) {
+    final int calcNonGapResidues( final MolecularSequence seq ) {
         int ng = 0;
         for( int i = 0; i < seq.getLength(); ++i ) {
             if ( !seq.isGapAt( i ) ) {
@@ -82,24 +564,6 @@ public class MsaCompactor {
         return ng;
     }
 
-    Phylogeny pi( final String matrix ) {
-        final Phylogeny master_phy = inferNJphylogeny( PWD_DISTANCE_METHOD.KIMURA_DISTANCE, _msa, true, matrix );
-        final int seed = 15;
-        final int n = 100;
-        final ResampleableMsa resampleable_msa = new ResampleableMsa( ( BasicMsa ) _msa );
-        final int[][] resampled_column_positions = BootstrapResampler.createResampledColumnPositions( _msa.getLength(),
-                                                                                                      n,
-                                                                                                      seed );
-        final Phylogeny[] eval_phys = new Phylogeny[ n ];
-        for( int i = 0; i < n; ++i ) {
-            resampleable_msa.resample( resampled_column_positions[ i ] );
-            eval_phys[ i ] = inferNJphylogeny( PWD_DISTANCE_METHOD.KIMURA_DISTANCE, resampleable_msa, false, null );
-        }
-        ConfidenceAssessor.evaluate( "bootstrap", eval_phys, master_phy, true, 1 );
-        PhylogenyMethods.extractFastaInformation( master_phy );
-        return master_phy;
-    }
-
     private final GapContribution[] calcGapContribtions( final boolean normalize_for_effective_seq_length ) {
         final double gappiness[] = calcGappiness();
         final GapContribution stats[] = new GapContribution[ _msa.getNumberOfSequences() ];
@@ -120,23 +584,9 @@ public class MsaCompactor {
         return stats;
     }
 
-    final private GapContribution[] calcGapContribtionsStats( final boolean norm ) {
-        final GapContribution stats[] = calcGapContribtions( norm );
+    final private GapContribution[] calcGapContribtionsStats( final boolean normalize_for_effective_seq_length ) {
+        final GapContribution stats[] = calcGapContribtions( normalize_for_effective_seq_length );
         Arrays.sort( stats );
-        // for( final GapContribution stat : stats ) {
-        //  final StringBuilder sb = new StringBuilder();
-        //  sb.append( stat.getId() );
-        //  sb.append( "\t" );
-        //  sb.append( NF_4.format( stat.getValue() ) );
-        //  sb.append( "\t" );
-        //            sb.append( NF_4.format( stat.median() ) );
-        //            sb.append( "\t" );
-        //            sb.append( NF_4.format( stat.getMin() ) );
-        //            sb.append( "\t" );
-        //            sb.append( NF_4.format( stat.getMax() ) );
-        //sb.append( "\t" );
-        //System.out.println( sb );
-        // }
         return stats;
     }
 
@@ -150,10 +600,16 @@ public class MsaCompactor {
         return gappiness;
     }
 
-    private Phylogeny inferNJphylogeny( final PWD_DISTANCE_METHOD pwd_distance_method,
-                                        final Msa msa,
-                                        final boolean write_matrix,
-                                        final String matrix_name ) {
+    private final Phylogeny collapse( final Msa msa, final int threshold ) {
+        final BasicSymmetricalDistanceMatrix m = PairwiseDistanceCalculator.calcFractionalDissimilarities( msa );
+        //TODO
+        return null;
+    }
+
+    private final Phylogeny inferNJphylogeny( final PWD_DISTANCE_METHOD pwd_distance_method,
+                                              final Msa msa,
+                                              final boolean write_matrix,
+                                              final String matrix_name ) {
         BasicSymmetricalDistanceMatrix m = null;
         switch ( pwd_distance_method ) {
             case KIMURA_DISTANCE:
@@ -173,7 +629,6 @@ public class MsaCompactor {
                 m.write( ForesterUtil.createBufferedWriter( matrix_name ) );
             }
             catch ( final IOException e ) {
-                // TODO Auto-generated catch block
                 e.printStackTrace();
             }
         }
@@ -182,200 +637,118 @@ public class MsaCompactor {
         return phy;
     }
 
-    private StringBuilder msaStatsAsSB() {
+    private final boolean isPrintMsaStats( final int i ) {
+        return ( ( ( _step == 1 ) && ( _step_for_diagnostics == 1 ) ) || ( ( _step_for_diagnostics > 0 ) && ( ( ( i + 1 ) % _step_for_diagnostics ) == 0 ) ) );
+    }
+
+    private final boolean isPrintMsaStatsWriteOutfileAndRealign( final int i ) {
+        return ( ( ( _step == 1 ) && ( _step_for_diagnostics == 1 ) ) || ( ( _step > 0 ) && ( ( ( i + 1 ) % _step ) == 0 ) ) );
+    }
+
+    private final StringBuilder msaPropertiesAsSB( final MsaProperties msa_properties ) {
         final StringBuilder sb = new StringBuilder();
-        sb.append( _msa.getNumberOfSequences() );
+        sb.append( msa_properties.getNumberOfSequences() );
         sb.append( "\t" );
-        sb.append( _msa.getLength() );
+        sb.append( msa_properties.getLength() );
         sb.append( "\t" );
-        sb.append( NF_3.format( MsaMethods.calcGapRatio( _msa ) ) );
+        sb.append( NF_4.format( msa_properties.getGapRatio() ) );
         sb.append( "\t" );
-        sb.append( NF_3.format( calculateIdentityRatio( 0, _msa.getLength() - 1, _msa ).arithmeticMean() ) );
+        sb.append( NF_1.format( msa_properties.getAvgNumberOfGaps() ) );
+        if ( _calculate_shannon_entropy ) {
+            sb.append( "\t" );
+            sb.append( NF_4.format( msa_properties.getEntropy7() ) );
+            sb.append( "\t" );
+            sb.append( NF_4.format( msa_properties.getEntropy21() ) );
+        }
         return sb;
     }
 
-    final private void realignWithMafft() throws IOException, InterruptedException {
-        //  final MsaInferrer mafft = Mafft
-        //       .createInstance( "/home/czmasek/SOFTWARE/MSA/MAFFT/mafft-7.130-without-extensions/scripts/mafft" );
-        final MsaInferrer mafft = Mafft.createInstance( _path_to_mafft );
-        final List<String> opts = new ArrayList<String>();
-        opts.add( "--maxiterate" );
-        opts.add( "1000" );
-        opts.add( "--localpair" );
-        opts.add( "--quiet" );
-        _msa = mafft.infer( _msa.asSequenceList(), opts );
-    }
-
-    final private void removeGapColumns() {
-        _msa = MsaMethods.createInstance().removeGapColumns( 1, 0, _msa );
-    }
-
-    final private void removeViaGapAverage( final double mean_gapiness,
-                                            final int step,
-                                            final boolean realign,
-                                            final boolean norm,
-                                            final boolean verbose ) throws IOException, InterruptedException {
-        final GapContribution stats[] = calcGapContribtionsStats( norm );
-        final List<String> to_remove_ids = new ArrayList<String>();
-        for( final GapContribution gap_gontribution : stats ) {
-            to_remove_ids.add( gap_gontribution.getId() );
+    private String obtainSuffix() {
+        if ( _output_format == MSA_FORMAT.FASTA ) {
+            return ".fasta";
         }
-        int i = 0;
-        while ( MsaMethods.calcGapRatio( _msa ) > mean_gapiness ) {
-            final String id = to_remove_ids.get( i );
-            _msa = MsaMethods.removeSequence( _msa, id );
-            removeGapColumns();
-            if ( verbose ) {
-                System.out.print( ForesterUtil.pad( id, 20, ' ', false ) );
-                System.out.print( "\t" );
-                final StringBuilder sb = msaStatsAsSB();
-                System.out.print( sb );
-                System.out.print( "\t" );
-            }
-            if ( ( ( ( i + 1 ) % step ) == 0 ) || ( MsaMethods.calcGapRatio( _msa ) <= mean_gapiness ) ) {
-                if ( realign ) {
-                    realignWithMafft();
-                }
-                final String s = writeOutfile();
-                if ( verbose ) {
-                    System.out.print( "-> " + s );
-                }
-            }
-            if ( verbose ) {
-                System.out.println();
-            }
-            ++i;
+        else if ( _output_format == MSA_FORMAT.PHYLIP ) {
+            return ".aln";
         }
+        return "";
     }
 
-    final private void removeViaGapAverageOLD( final double mean_gapiness,
-                                               final int step,
-                                               final boolean realign,
-                                               final File outfile,
-                                               final int minimal_effective_length ) throws IOException,
-            InterruptedException {
-        if ( step < 1 ) {
-            throw new IllegalArgumentException( "step cannot be less than 1" );
-        }
-        if ( mean_gapiness < 0 ) {
-            throw new IllegalArgumentException( "target average gap ratio cannot be less than 0" );
-        }
-        if ( VERBOSE ) {
-            System.out.println( "orig: " + msaStatsAsSB() );
-        }
-        if ( minimal_effective_length > 1 ) {
-            _msa = MsaMethods.removeSequencesByMinimalLength( _msa, minimal_effective_length );
-            if ( VERBOSE ) {
-                System.out.println( "short seq removal: " + msaStatsAsSB() );
-            }
-        }
-        int counter = step;
-        double gr;
-        do {
-            removeWorstOffenders( step, 1, false, false, false );
-            if ( realign ) {
-                realignWithMafft();
-            }
-            gr = MsaMethods.calcGapRatio( _msa );
-            if ( VERBOSE ) {
-                System.out.println( counter + ": " + msaStatsAsSB() );
-            }
-            //   write( outfile, gr );
-            counter += step;
-        } while ( gr > mean_gapiness );
-        if ( VERBOSE ) {
-            System.out.println( "final: " + msaStatsAsSB() );
+    private final Phylogeny pi( final String matrix, final int boostrap ) {
+        final Phylogeny master_phy = inferNJphylogeny( PWD_DISTANCE_METHOD.KIMURA_DISTANCE, _msa, true, matrix );
+        final int seed = 15;
+        final int n = 100;
+        final ResampleableMsa resampleable_msa = new ResampleableMsa( _msa );
+        final int[][] resampled_column_positions = BootstrapResampler.createResampledColumnPositions( _msa.getLength(),
+                                                                                                      n,
+                                                                                                      seed );
+        final Phylogeny[] eval_phys = new Phylogeny[ n ];
+        for( int i = 0; i < n; ++i ) {
+            resampleable_msa.resample( resampled_column_positions[ i ] );
+            eval_phys[ i ] = inferNJphylogeny( PWD_DISTANCE_METHOD.KIMURA_DISTANCE, resampleable_msa, false, null );
         }
+        ConfidenceAssessor.evaluate( "bootstrap", eval_phys, master_phy, true, 1 );
+        PhylogenyMethods.extractFastaInformation( master_phy );
+        return master_phy;
     }
 
-    final private void removeViaLength( final int length,
-                                        final int step,
-                                        final boolean realign,
-                                        final boolean norm,
-                                        final boolean verbose ) throws IOException, InterruptedException {
-        final GapContribution stats[] = calcGapContribtionsStats( norm );
-        final List<String> to_remove_ids = new ArrayList<String>();
-        for( final GapContribution gap_gontribution : stats ) {
-            to_remove_ids.add( gap_gontribution.getId() );
+    private final void printMsaProperties( final MsaProperties msa_properties ) {
+        if ( ( _step == 1 ) || ( _step_for_diagnostics == 1 ) ) {
+            System.out.print( ForesterUtil.pad( msa_properties.getRemovedSeq(), _longest_id_length, ' ', false ) );
+            System.out.print( "\t" );
         }
-        int i = 0;
-        while ( _msa.getLength() > length ) {
-            final String id = to_remove_ids.get( i );
-            _msa = MsaMethods.removeSequence( _msa, id );
-            removeGapColumns();
-            if ( verbose ) {
-                System.out.print( ForesterUtil.pad( id, 20, ' ', false ) );
-                System.out.print( "\t" );
-                final StringBuilder sb = msaStatsAsSB();
-                System.out.print( sb );
-                System.out.print( "\t" );
-            }
-            if ( ( ( ( i + 1 ) % step ) == 0 ) || ( _msa.getLength() <= length ) ) {
-                if ( realign ) {
-                    realignWithMafft();
-                }
-                final String s = writeOutfile();
-                if ( verbose ) {
-                    System.out.print( "-> " + s );
-                }
-            }
-            if ( verbose ) {
-                System.out.println();
-            }
-            ++i;
+        System.out.print( msaPropertiesAsSB( msa_properties ) );
+        System.out.print( "\t" );
+    }
+
+    final private MsaProperties printMsaStatsWriteOutfileAndRealign( final boolean realign, final String id )
+            throws IOException, InterruptedException {
+        if ( realign ) {
+            realignWithMafft();
         }
+        final MsaProperties msa_prop = new MsaProperties( _msa, id, _calculate_shannon_entropy );
+        printMsaProperties( msa_prop );
+        final String s = writeOutfile();
+        System.out.print( "-> " + s + ( realign ? "\t(realigned)" : "" ) );
+        return msa_prop;
     }
 
-    final private void removeWorstOffenders( final int to_remove,
-                                             final int step,
-                                             final boolean realign,
-                                             final boolean norm,
-                                             final boolean verbose ) throws IOException, InterruptedException {
-        final GapContribution stats[] = calcGapContribtionsStats( norm );
-        final List<String> to_remove_ids = new ArrayList<String>();
-        for( int j = 0; j < to_remove; ++j ) {
-            to_remove_ids.add( stats[ j ].getId() );
-            _removed_seq_ids.add( stats[ j ].getId() );
+    private final void printTableHeader() {
+        if ( ( _step == 1 ) || ( _step_for_diagnostics == 1 ) ) {
+            System.out.print( ForesterUtil.pad( "Id", _longest_id_length, ' ', false ) );
+            System.out.print( "\t" );
         }
-        for( int i = 0; i < to_remove_ids.size(); ++i ) {
-            final String id = to_remove_ids.get( i );
-            _msa = MsaMethods.removeSequence( _msa, id );
-            removeGapColumns();
-            if ( verbose ) {
-                System.out.print( ForesterUtil.pad( id, 20, ' ', false ) );
-                System.out.print( "\t" );
-                final StringBuilder sb = msaStatsAsSB();
-                System.out.print( sb );
-                System.out.print( "\t" );
-            }
-            if ( ( ( ( i + 1 ) % step ) == 0 ) || ( i == ( to_remove_ids.size() - 1 ) ) ) {
-                if ( realign ) {
-                    realignWithMafft();
-                }
-                final String s = writeOutfile();
-                if ( verbose ) {
-                    System.out.print( "-> " + s );
-                }
-            }
-            if ( verbose ) {
-                System.out.println();
-            }
+        System.out.print( "Seqs" );
+        System.out.print( "\t" );
+        System.out.print( "Length" );
+        System.out.print( "\t" );
+        System.out.print( "Gap R" );
+        System.out.print( "\t" );
+        System.out.print( "Gaps" );
+        System.out.print( "\t" );
+        if ( _calculate_shannon_entropy ) {
+            System.out.print( "entn7" );
+            System.out.print( "\t" );
+            System.out.print( "entn21" );
+            System.out.print( "\t" );
         }
+        System.out.println();
     }
 
-    private void setPathToMafft( final String path_to_mafft ) {
-        _path_to_mafft = path_to_mafft;
+    final private void realignWithMafft() throws IOException, InterruptedException {
+        final MsaInferrer mafft = Mafft.createInstance( _path_to_mafft );
+        final List<String> opts = new ArrayList<String>();
+        for( final String o : _maffts_opts.split( "\\s" ) ) {
+            opts.add( o );
+        }
+        _msa = DeleteableMsa.createInstance( mafft.infer( _msa.asSequenceList(), opts ) );
     }
 
-    final private void writeMsa( final String outfile, final MSA_FORMAT format ) throws IOException {
-        final Writer w = ForesterUtil.createBufferedWriter( outfile );
-        _msa.write( w, format );
-        w.close();
+    final private void removeGapColumns() {
+        _msa.deleteGapOnlyColumns();
     }
 
-    private String writeOutfile() throws IOException {
-        final String s = writeMsa( _out_file_base, MSA_FORMAT.PHYLIP, ".aln" );
-        //writeMsa( _out_file_base, MSA_FORMAT.FASTA, ".fasta" );
+    private final String writeOutfile() throws IOException {
+        final String s = writeMsa( _out_file_base );
         return s;
     }
 
@@ -388,6 +761,10 @@ public class MsaCompactor {
                 return path;
             }
         }
+        path = "/home/czmasek/SOFTWARE/MSA/MAFFT/mafft-7.130-without-extensions/scripts/mafft";
+        if ( MsaInferrer.isInstalled( path ) ) {
+            return path;
+        }
         path = "/usr/local/bin/mafft";
         if ( MsaInferrer.isInstalled( path ) ) {
             return path;
@@ -407,59 +784,10 @@ public class MsaCompactor {
         return null;
     }
 
-    public final static MsaCompactor reduceGapAverage( final Msa msa,
-                                                       final double max_gap_average,
-                                                       final int step,
-                                                       final boolean realign,
-                                                       final boolean norm,
-                                                       final String path_to_mafft,
-                                                       final File out ) throws IOException, InterruptedException {
-        final MsaCompactor mc = new MsaCompactor( msa );
-        if ( realign ) {
-            mc.setPathToMafft( path_to_mafft );
-        }
-        mc.setOutFileBase( out );
-        mc.removeViaGapAverage( max_gap_average, step, realign, norm, true );
-        return mc;
-    }
-
-    public final static MsaCompactor reduceLength( final Msa msa,
-                                                   final int length,
-                                                   final int step,
-                                                   final boolean realign,
-                                                   final boolean norm,
-                                                   final String path_to_mafft,
-                                                   final File out ) throws IOException, InterruptedException {
-        final MsaCompactor mc = new MsaCompactor( msa );
-        if ( realign ) {
-            mc.setPathToMafft( path_to_mafft );
-        }
-        mc.setOutFileBase( out );
-        mc.removeViaLength( length, step, realign, norm, true );
-        return mc;
-    }
-
-    public final static MsaCompactor removeWorstOffenders( final Msa msa,
-                                                           final int worst_offenders_to_remove,
-                                                           final int step,
-                                                           final boolean realign,
-                                                           final boolean norm,
-                                                           final String path_to_mafft,
-                                                           final File out ) throws IOException, InterruptedException {
-        final MsaCompactor mc = new MsaCompactor( msa );
-        if ( realign ) {
-            mc.setPathToMafft( path_to_mafft );
-        }
-        mc.setOutFileBase( out );
-        mc.removeWorstOffenders( worst_offenders_to_remove, step, realign, norm, true );
-        return mc;
-    }
-
-    private static DescriptiveStatistics calculateIdentityRatio( final int from, final int to, final Msa msa ) {
-        final DescriptiveStatistics stats = new BasicDescriptiveStatistics();
-        for( int c = from; c <= to; ++c ) {
-            stats.addValue( MsaMethods.calculateIdentityRatio( msa, c ) );
-        }
-        return stats;
+    final private static void writeMsa( final Msa msa, final String outfile, final MSA_FORMAT format )
+            throws IOException {
+        final Writer w = ForesterUtil.createBufferedWriter( outfile );
+        msa.write( w, format );
+        w.close();
     }
 }