forester/java/src/org/forester/application/msa_compactor.java

   1 // $Id:
   2 // FORESTER -- software libraries and applications
   3 // for evolutionary biology research and applications.
   4 //
   5 // Copyright (C) 2014 Christian M. Zmasek
   6 // Copyright (C) 2014 Sanford-Burnham Medical Research Institute
   7 // All rights reserved
   8 //
   9 // This library is free software; you can redistribute it and/or
  10 // modify it under the terms of the GNU Lesser General Public
  11 // License as published by the Free Software Foundation; either
  12 // version 2.1 of the License, or (at your option) any later version.
  13 //
  14 // This library is distributed in the hope that it will be useful,
  15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17 // Lesser General Public License for more details.
  18 //
  19 // You should have received a copy of the GNU Lesser General Public
  20 // License along with this library; if not, write to the Free Software
  21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  22 //
  23 // WWW: https://sites.google.com/site/cmzmasek/home/software/forester
  24
  25 package org.forester.application;
  26
  27 import java.io.File;
  28 import java.io.FileInputStream;
  29 import java.io.IOException;
  30 import java.math.RoundingMode;
  31 import java.text.DecimalFormat;
  32 import java.text.NumberFormat;
  33 import java.util.ArrayList;
  34 import java.util.List;
  35
  36 import org.forester.io.parsers.FastaParser;
  37 import org.forester.io.parsers.GeneralMsaParser;
  38 import org.forester.msa.DeleteableMsa;
  39 import org.forester.msa.Msa.MSA_FORMAT;
  40 import org.forester.msa.MsaInferrer;
  41 import org.forester.msa.MsaMethods;
  42 import org.forester.msa_compactor.Chart;
  43 import org.forester.msa_compactor.MsaCompactor;
  44 import org.forester.msa_compactor.MsaProperties;
  45 import org.forester.util.CommandLineArguments;
  46 import org.forester.util.DescriptiveStatistics;
  47 import org.forester.util.ForesterUtil;
  48
  49 public class msa_compactor {
  50
  51     final private static NumberFormat NF_1                                   = new DecimalFormat( "0.#" );
  52     final private static NumberFormat NF_4                                   = new DecimalFormat( "0.####" );
  53     static {
  54         NF_1.setRoundingMode( RoundingMode.HALF_UP );
  55         NF_4.setRoundingMode( RoundingMode.HALF_UP );
  56     }
  57     final static private String       HELP_OPTION_1                          = "help";
  58     final static private String       HELP_OPTION_2                          = "h";
  59     final static private String       REMOVE_WORST_OFFENDERS_OPTION          = "r";
  60     final static private String       AV_GAPINESS_OPTION                     = "g";
  61     final static private String       STEP_OPTION                            = "s";
  62     final static private String       LENGTH_OPTION                          = "l";
  63     final static private String       REALIGN_OPTION                         = "a";
  64     //
  65     final static private String       STEP_FOR_DIAGNOSTICS_OPTION            = "sd";
  66     final static private String       MIN_LENGTH_OPTION                      = "ml";
  67     final static private String       GAP_RATIO_LENGTH_OPTION                = "gr";
  68     final static private String       REPORT_ENTROPY                         = "e";
  69     final static private String       OUTPUT_FORMAT_OPTION                   = "f";
  70     final static private String       OUTPUT_REMOVED_SEQS_OPTION             = "ro";
  71     final static private String       MAFFT_OPTIONS                          = "mo";
  72     final static private String       PERFORM_PHYLOGENETIC_INFERENCE         = "t";
  73     //
  74     final static private String       PATH_TO_MAFFT_OPTION                   = "mafft";
  75     final static private String       DO_NOT_NORMALIZE_FOR_EFF_LENGTH_OPTION = "nn";
  76     final static private String       PRG_NAME                               = "msa_compactor";
  77     final static private String       PRG_DESC                               = "multiple sequence aligment compactor";
  78     final static private String       PRG_VERSION                            = "0.3";
  79     final static private String       PRG_DATE                               = "140508";
  80     final static private String       E_MAIL                                 = "czmasek@sanfordburham.org";
  81     final static private String       WWW                                    = "https://sites.google.com/site/cmzmasek/home/software/forester";
  82
  83     public static void main( final String args[] ) {
  84         try {
  85             final CommandLineArguments cla = new CommandLineArguments( args );
  86             if ( cla.isOptionSet( HELP_OPTION_1 ) || cla.isOptionSet( HELP_OPTION_2 )
  87                     || ( ( cla.getNumberOfNames() < 1 ) || ( cla.getNumberOfNames() > 2 ) ) ) {
  88                 printHelp();
  89                 System.exit( 0 );
  90             }
  91             final File in = cla.getFile( 0 );
  92             File out = null;
  93             if ( cla.getNumberOfNames() > 1 ) {
  94                 out = cla.getFile( 1 );
  95             }
  96             int worst_remove = -1;
  97             double av_gap = -1;
  98             int length = -1;
  99             int step = 1;
 100             boolean realign = false;
 101             boolean norm = true;
 102             String path_to_mafft = null;
 103             int step_for_diagnostics = 1;
 104             int min_length = -1;
 105             double gap_ratio = -1;
 106             boolean report_entropy = false;
 107             MSA_FORMAT output_format = MSA_FORMAT.FASTA;
 108             File removed_seqs_out_base = null;
 109             String mafft_options = "--auto";
 110             boolean perform_phylogenetic_inference = false;
 111             final List<String> allowed_options = new ArrayList<String>();
 112             allowed_options.add( REMOVE_WORST_OFFENDERS_OPTION );
 113             allowed_options.add( AV_GAPINESS_OPTION );
 114             allowed_options.add( LENGTH_OPTION );
 115             allowed_options.add( REALIGN_OPTION );
 116             allowed_options.add( DO_NOT_NORMALIZE_FOR_EFF_LENGTH_OPTION );
 117             allowed_options.add( STEP_OPTION );
 118             allowed_options.add( PATH_TO_MAFFT_OPTION );
 119             allowed_options.add( STEP_FOR_DIAGNOSTICS_OPTION );
 120             allowed_options.add( MIN_LENGTH_OPTION );
 121             allowed_options.add( GAP_RATIO_LENGTH_OPTION );
 122             allowed_options.add( REPORT_ENTROPY );
 123             allowed_options.add( OUTPUT_FORMAT_OPTION );
 124             allowed_options.add( OUTPUT_REMOVED_SEQS_OPTION );
 125             allowed_options.add( MAFFT_OPTIONS );
 126             allowed_options.add( PERFORM_PHYLOGENETIC_INFERENCE );
 127             final String dissallowed_options = cla.validateAllowedOptionsAsString( allowed_options );
 128             if ( dissallowed_options.length() > 0 ) {
 129                 ForesterUtil.fatalError( PRG_NAME, "unknown option(s): " + dissallowed_options );
 130             }
 131             DeleteableMsa msa = null;
 132             final FileInputStream is = new FileInputStream( in );
 133             if ( FastaParser.isLikelyFasta( in ) ) {
 134                 msa = DeleteableMsa.createInstance( FastaParser.parseMsa( is ) );
 135             }
 136             else {
 137                 msa = DeleteableMsa.createInstance( GeneralMsaParser.parse( is ) );
 138             }
 139             final DescriptiveStatistics initial_msa_stats = MsaMethods.calculateEffectiveLengthStatistics( msa );
 140             final boolean chart_only = ( !cla.isOptionSet( LENGTH_OPTION ) )
 141                     && ( !cla.isOptionSet( REMOVE_WORST_OFFENDERS_OPTION ) )
 142                     && ( !cla.isOptionSet( AV_GAPINESS_OPTION ) && ( !cla.isOptionSet( MIN_LENGTH_OPTION ) ) );
 143             if ( !chart_only && ( out == null ) ) {
 144                 ForesterUtil.fatalError( PRG_NAME, "outfile file missing" );
 145             }
 146             if ( cla.isOptionSet( REMOVE_WORST_OFFENDERS_OPTION ) ) {
 147                 worst_remove = cla.getOptionValueAsInt( REMOVE_WORST_OFFENDERS_OPTION );
 148                 if ( ( worst_remove < 1 ) || ( worst_remove >= ( msa.getNumberOfSequences() - 1 ) ) ) {
 149                     ForesterUtil.fatalError( PRG_NAME, "number of worst offender sequences to remove is out of range: "
 150                             + worst_remove );
 151                 }
 152             }
 153             if ( cla.isOptionSet( AV_GAPINESS_OPTION ) ) {
 154                 if ( cla.isOptionSet( REMOVE_WORST_OFFENDERS_OPTION ) ) {
 155                     printHelp();
 156                     System.exit( 0 );
 157                 }
 158                 av_gap = cla.getOptionValueAsDouble( AV_GAPINESS_OPTION );
 159                 if ( ( av_gap < 0 ) || ( av_gap >= 1 ) ) {
 160                     ForesterUtil.fatalError( PRG_NAME, "target gap-ratio is out of range: " + av_gap );
 161                 }
 162             }
 163             if ( cla.isOptionSet( LENGTH_OPTION ) ) {
 164                 if ( cla.isOptionSet( REMOVE_WORST_OFFENDERS_OPTION ) || cla.isOptionSet( AV_GAPINESS_OPTION ) ) {
 165                     printHelp();
 166                     System.exit( 0 );
 167                 }
 168                 length = cla.getOptionValueAsInt( LENGTH_OPTION );
 169                 if ( length >= msa.getLength() ) {
 170                     ForesterUtil.fatalError( PRG_NAME,
 171                                              "target length is out of range [longer than MSA (" + msa.getLength()
 172                                                      + ")]: " + length );
 173                 }
 174                 else if ( length < initial_msa_stats.getMin() ) {
 175                     ForesterUtil.fatalError( PRG_NAME,
 176                                              "target length is out of range [shorter than the shortest sequence ("
 177                                                      + initial_msa_stats.getMin() + ") ]: " + length );
 178                 }
 179             }
 180             if ( cla.isOptionSet( MIN_LENGTH_OPTION ) ) {
 181                 if ( cla.isOptionSet( LENGTH_OPTION ) || cla.isOptionSet( REMOVE_WORST_OFFENDERS_OPTION )
 182                         || cla.isOptionSet( AV_GAPINESS_OPTION ) || cla.isOptionSet( STEP_OPTION )
 183                         || cla.isOptionSet( REALIGN_OPTION ) || cla.isOptionSet( PATH_TO_MAFFT_OPTION )
 184                         || cla.isOptionSet( STEP_FOR_DIAGNOSTICS_OPTION ) || cla.isOptionSet( REPORT_ENTROPY )
 185                         || cla.isOptionSet( OUTPUT_REMOVED_SEQS_OPTION )
 186                         || cla.isOptionSet( PERFORM_PHYLOGENETIC_INFERENCE ) ) {
 187                     printHelp();
 188                     System.exit( 0 );
 189                 }
 190                 min_length = cla.getOptionValueAsInt( MIN_LENGTH_OPTION );
 191                 if ( ( min_length < 2 ) || ( min_length > initial_msa_stats.getMax() ) ) {
 192                     ForesterUtil.fatalError( PRG_NAME, "value for minimal sequence length is out of range: "
 193                             + min_length );
 194                 }
 195             }
 196             if ( cla.isOptionSet( STEP_OPTION ) ) {
 197                 step = cla.getOptionValueAsInt( STEP_OPTION );
 198                 if ( ( step < 1 )
 199                         || ( ( step > msa.getNumberOfSequences() ) || ( ( worst_remove > 0 ) && ( step > worst_remove ) ) ) ) {
 200                     ForesterUtil.fatalError( PRG_NAME, "value for step is out of range: " + step );
 201                 }
 202             }
 203             if ( cla.isOptionSet( REALIGN_OPTION ) ) {
 204                 realign = true;
 205             }
 206             if ( cla.isOptionSet( PATH_TO_MAFFT_OPTION ) ) {
 207                 if ( !realign ) {
 208                     ForesterUtil.fatalError( PRG_NAME, "no need to indicate path to MAFFT without realigning" );
 209                 }
 210                 path_to_mafft = cla.getOptionValueAsCleanString( PATH_TO_MAFFT_OPTION );
 211             }
 212             if ( cla.isOptionSet( DO_NOT_NORMALIZE_FOR_EFF_LENGTH_OPTION ) ) {
 213                 norm = false;
 214             }
 215             if ( cla.isOptionSet( STEP_FOR_DIAGNOSTICS_OPTION ) ) {
 216                 step_for_diagnostics = cla.getOptionValueAsInt( STEP_FOR_DIAGNOSTICS_OPTION );
 217                 if ( ( step_for_diagnostics < 1 )
 218                         || ( ( step_for_diagnostics > msa.getNumberOfSequences() ) || ( ( worst_remove > 0 ) && ( step_for_diagnostics > worst_remove ) ) ) ) {
 219                     ForesterUtil.fatalError( PRG_NAME, "value for diagnostic step is out of range: "
 220                             + step_for_diagnostics );
 221                 }
 222             }
 223             if ( cla.isOptionSet( GAP_RATIO_LENGTH_OPTION ) ) {
 224                 gap_ratio = cla.getOptionValueAsDouble( GAP_RATIO_LENGTH_OPTION );
 225                 if ( ( gap_ratio < 0 ) || ( gap_ratio > 1 ) ) {
 226                     ForesterUtil.fatalError( PRG_NAME, "gap ratio is out of range: " + gap_ratio );
 227                 }
 228             }
 229             if ( cla.isOptionSet( REPORT_ENTROPY ) ) {
 230                 report_entropy = true;
 231             }
 232             if ( cla.isOptionSet( OUTPUT_FORMAT_OPTION ) ) {
 233                 final String fs = cla.getOptionValueAsCleanString( OUTPUT_FORMAT_OPTION );
 234                 if ( fs.equalsIgnoreCase( "p" ) ) {
 235                     output_format = MSA_FORMAT.PHYLIP;
 236                 }
 237                 else if ( fs.equalsIgnoreCase( "f" ) ) {
 238                     output_format = MSA_FORMAT.FASTA;
 239                 }
 240                 else if ( fs.equalsIgnoreCase( "n" ) ) {
 241                     output_format = MSA_FORMAT.NEXUS;
 242                 }
 243                 else {
 244                     ForesterUtil.fatalError( PRG_NAME, "illegal or empty output format option: " + fs );
 245                 }
 246             }
 247             if ( cla.isOptionSet( OUTPUT_REMOVED_SEQS_OPTION ) ) {
 248                 final String s = cla.getOptionValueAsCleanString( OUTPUT_REMOVED_SEQS_OPTION );
 249                 removed_seqs_out_base = new File( s );
 250             }
 251             if ( realign ) {
 252                 if ( ForesterUtil.isEmpty( path_to_mafft ) ) {
 253                     path_to_mafft = MsaCompactor.guessPathToMafft();
 254                 }
 255                 checkPathToMafft( path_to_mafft );
 256                 if ( cla.isOptionSet( MAFFT_OPTIONS ) ) {
 257                     mafft_options = cla.getOptionValueAsCleanString( MAFFT_OPTIONS );
 258                     if ( ForesterUtil.isEmpty( mafft_options ) || ( mafft_options.length() < 3 ) ) {
 259                         ForesterUtil.fatalError( PRG_NAME, "illegal or empty MAFFT options: " + mafft_options );
 260                     }
 261                 }
 262             }
 263             else if ( cla.isOptionSet( MAFFT_OPTIONS ) ) {
 264                 ForesterUtil.fatalError( PRG_NAME, "no need to indicate MAFFT options without realigning" );
 265             }
 266             if ( cla.isOptionSet( PERFORM_PHYLOGENETIC_INFERENCE ) ) {
 267                 perform_phylogenetic_inference = true;
 268             }
 269             if ( chart_only ) {
 270                 if ( ( out != null ) || ( removed_seqs_out_base != null ) ) {
 271                     ForesterUtil
 272                             .fatalError( PRG_NAME,
 273                                          "chart only, no outfile(s) produced, thus no need to indicate output file(s)" );
 274                 }
 275                 if ( !realign && cla.isOptionSet( STEP_OPTION ) ) {
 276                     ForesterUtil.fatalError( PRG_NAME,
 277                                              "chart only, no re-aligning, thus no need to use step for output and re-aligning; use -"
 278                                                      + STEP_FOR_DIAGNOSTICS_OPTION + " instead" );
 279                 }
 280             }
 281             if ( perform_phylogenetic_inference ) {
 282                 if ( step_for_diagnostics != 1 ) {
 283                     ForesterUtil.fatalError( PRG_NAME,
 284                                              "step for diagnostics reports needs to be set to 1 for tree calculation" );
 285                 }
 286             }
 287             ForesterUtil.printProgramInformation( PRG_NAME,
 288                                                   PRG_DESC,
 289                                                   PRG_VERSION,
 290                                                   PRG_DATE,
 291                                                   E_MAIL,
 292                                                   WWW,
 293                                                   ForesterUtil.getForesterLibraryInformation() );
 294             System.out.println( "Input MSA                            : " + in );
 295             System.out.println( "  MSA length                         : " + msa.getLength() );
 296             System.out.println( "  Number of sequences                : " + msa.getNumberOfSequences() );
 297             System.out.println( "  Median sequence length             : " + NF_1.format( initial_msa_stats.median() ) );
 298             System.out.println( "  Mean sequence length               : "
 299                     + NF_1.format( initial_msa_stats.arithmeticMean() ) );
 300             System.out.println( "  Max sequence length                : " + ( ( int ) initial_msa_stats.getMax() ) );
 301             System.out.println( "  Min sequence length                : " + ( ( int ) initial_msa_stats.getMin() ) );
 302             System.out.println( "  Gap ratio                          : "
 303                     + NF_4.format( MsaMethods.calcGapRatio( msa ) ) );
 304             System.out.println( "  Normalized Shannon Entropy (entn21): "
 305                     + NF_4.format( MsaMethods.calcNormalizedShannonsEntropy( 21, msa ) ) );
 306             if ( !chart_only ) {
 307                 System.out.println( "Output                               : " + out );
 308             }
 309             else {
 310                 System.out.println( "Output                               : n/a" );
 311             }
 312             if ( removed_seqs_out_base != null ) {
 313                 System.out.println( "Write removed sequences to           : " + removed_seqs_out_base );
 314             }
 315             if ( worst_remove > 0 ) {
 316                 System.out.println( "Number of worst offenders to remove  : " + worst_remove );
 317             }
 318             if ( av_gap > 0 ) {
 319                 System.out.println( "Target gap-ratio                     : " + av_gap );
 320             }
 321             if ( length > 0 ) {
 322                 System.out.println( "Target MSA length                    : " + length );
 323             }
 324             if ( min_length > 1 ) {
 325                 System.out.println( "Minimal effective sequence length    : " + min_length );
 326             }
 327             if ( gap_ratio > -1 ) {
 328                 System.out.println( "Maximum allowed gap ratio per column : " + gap_ratio );
 329             }
 330             if ( ( out != null ) || ( removed_seqs_out_base != null ) ) {
 331                 System.out.print( "Output format                        : " );
 332                 if ( output_format == MSA_FORMAT.FASTA ) {
 333                     System.out.println( "fasta" );
 334                 }
 335                 else if ( output_format == MSA_FORMAT.PHYLIP ) {
 336                     System.out.println( "phylip" );
 337                 }
 338                 else if ( output_format == MSA_FORMAT.NEXUS ) {
 339                     System.out.println( "nexus" );
 340                 }
 341             }
 342             if ( min_length == -1 ) {
 343                 if ( chart_only && !realign ) {
 344                     System.out.println( "Step for output and re-aligning      : n/a" );
 345                 }
 346                 else {
 347                     if ( chart_only ) {
 348                         System.out.println( "Step for re-aligning                 : " + step );
 349                     }
 350                     else {
 351                         System.out.println( "Step for output and re-aligning      : " + step );
 352                     }
 353                 }
 354                 System.out.println( "Step for diagnostics reports         : " + step_for_diagnostics );
 355                 System.out.println( "Calculate normalized Shannon Entropy : " + report_entropy );
 356                 if ( !norm ) {
 357                     System.out.println( "Normalize                            : " + norm );
 358                 }
 359                 System.out.println( "Realign with MAFFT                   : " + realign );
 360                 if ( realign ) {
 361                     System.out.println( "MAFFT options                        : " + mafft_options );
 362                 }
 363                 System.out.println( "Simple tree (Kimura distances, NJ)   : " + perform_phylogenetic_inference );
 364             }
 365             System.out.println();
 366             final int initial_number_of_seqs = msa.getNumberOfSequences();
 367             List<MsaProperties> msa_props = null;
 368             final MsaCompactor mc = new MsaCompactor( msa );
 369             mc.setInfileName( in.getName() );
 370             if ( ( worst_remove > 0 ) || ( av_gap > 0 ) || ( length > 0 ) || ( min_length != -1 ) ) {
 371                 mc.setOutputFormat( output_format );
 372                 mc.setOutFileBase( out );
 373             }
 374             if ( min_length != -1 ) {
 375                 mc.removeSequencesByMinimalLength( min_length );
 376             }
 377             else {
 378                 mc.setPeformPhylogenticInference( perform_phylogenetic_inference );
 379                 if ( removed_seqs_out_base != null ) {
 380                     mc.setRemovedSeqsOutBase( removed_seqs_out_base );
 381                 }
 382                 mc.setNorm( norm );
 383                 mc.setRealign( realign );
 384                 if ( realign ) {
 385                     mc.setPathToMafft( path_to_mafft );
 386                     mc.setMafftOptions( mafft_options );
 387                 }
 388                 mc.setStep( step );
 389                 mc.setStepForDiagnostics( step_for_diagnostics );
 390                 mc.setCalculateNormalizedShannonEntropy( report_entropy );
 391                 if ( worst_remove > 0 ) {
 392                     msa_props = mc.removeWorstOffenders( worst_remove );
 393                 }
 394                 else if ( av_gap > 0 ) {
 395                     msa_props = mc.removeViaGapAverage( av_gap );
 396                 }
 397                 else if ( length > 0 ) {
 398                     msa_props = mc.removeViaLength( length );
 399                 }
 400                 else {
 401                     msa_props = mc.chart( step, realign, norm );
 402                 }
 403                 Chart.display( msa_props, initial_number_of_seqs, report_entropy, in.getName() );
 404             }
 405         }
 406         catch ( final IllegalArgumentException iae ) {
 407             //  iae.printStackTrace(); //TODO remove me
 408             ForesterUtil.fatalError( PRG_NAME, iae.getMessage() );
 409         }
 410         catch ( final IOException ioe ) {
 411             // ioe.printStackTrace(); //TODO remove me
 412             ForesterUtil.fatalError( PRG_NAME, ioe.getMessage() );
 413         }
 414         catch ( final Exception e ) {
 415             ForesterUtil.unexpectedFatalError( PRG_NAME, e );
 416         }
 417     }
 418
 419     private static void checkPathToMafft( final String path_to_mafft ) {
 420         if ( !ForesterUtil.isEmpty( path_to_mafft ) && MsaInferrer.isInstalled( path_to_mafft ) ) {
 421         }
 422         else {
 423             if ( ForesterUtil.isEmpty( path_to_mafft ) ) {
 424                 ForesterUtil.fatalError( PRG_NAME, "no MAFFT executable found, use -\"" + PATH_TO_MAFFT_OPTION
 425                         + "=<path to MAFFT>\" option" );
 426             }
 427             else {
 428                 ForesterUtil.fatalError( PRG_NAME, "no MAFFT executable at \"" + path_to_mafft + "\"" );
 429             }
 430         }
 431     }
 432
 433     private static void printHelp() {
 434         ForesterUtil.printProgramInformation( PRG_NAME,
 435                                               PRG_DESC,
 436                                               PRG_VERSION,
 437                                               PRG_DATE,
 438                                               E_MAIL,
 439                                               WWW,
 440                                               ForesterUtil.getForesterLibraryInformation() );
 441         final String path_to_mafft = MsaCompactor.guessPathToMafft();
 442         String mafft_comment;
 443         if ( !ForesterUtil.isEmpty( path_to_mafft ) ) {
 444             mafft_comment = " (using " + path_to_mafft + ")";
 445         }
 446         else {
 447             mafft_comment = " (no path to MAFFT found, use -\"" + PATH_TO_MAFFT_OPTION + "=<path to MAFFT>\" option";
 448         }
 449         System.out.println( "Usage:" );
 450         System.out.println();
 451         System.out.println( PRG_NAME + " <options> <msa input file> <output file base>" );
 452         System.out.println();
 453         System.out.println( " options: " );
 454         System.out.println();
 455         System.out.println( "   -" + REMOVE_WORST_OFFENDERS_OPTION
 456                 + "=<integer>   number of worst offender sequences to remove" );
 457         System.out.println( "   -" + LENGTH_OPTION + "=<integer>   target MSA length" );
 458         System.out.println( "   -" + AV_GAPINESS_OPTION + "=<decimal>   target gap-ratio (0.0-1.0)" );
 459         System.out.println( "   -" + REALIGN_OPTION + "             to realign using MAFFT" + mafft_comment );
 460         System.out.println( "   -" + MAFFT_OPTIONS + "=<string>   options for MAFFT (default: --auto)" );
 461         System.out.println( "   -" + STEP_OPTION + "=<integer>   step for output and re-aligning (default: 1)" );
 462         System.out.println( "   -" + STEP_FOR_DIAGNOSTICS_OPTION
 463                 + "=<integer>  step for diagnostics reports (default: 1)" );
 464         System.out.println( "   -" + REPORT_ENTROPY
 465                 + "             to calculate normalized Shannon Entropy (not recommended for very large alignments)" );
 466         System.out.println( "   -" + OUTPUT_FORMAT_OPTION
 467                 + "=<f|p|n>     format for output alignments: f for fasta (default), p for phylip, or n for nexus" );
 468         System.out.println( "   -" + OUTPUT_REMOVED_SEQS_OPTION + "=<file>     to output the removed sequences" );
 469         System.out.println( "   -" + MIN_LENGTH_OPTION
 470                 + "=<integer>  minimal effecive sequence length (for deleting of shorter sequences)" );
 471         System.out.println( "   -" + GAP_RATIO_LENGTH_OPTION
 472                 + "=<decimal>  maximal allowed gap ratio per column (for deleting of columms) (0.0-1.0)" );
 473         System.out.println( "   -" + PERFORM_PHYLOGENETIC_INFERENCE
 474                 + "             to calculate a simple phylogenetic tree (Kimura distances, NJ)" );
 475         System.out.println();
 476         System.out.println();
 477         System.out.println();
 478     }
 479 }