forester/ruby/evoruby/lib/evo/tool/phylogenies_decorator.rb

   1 #!/usr/local/bin/ruby -w
   2 #
   3 # = lib/evo/apps/phylogenies_decorator
   4 #
   5 # Copyright::  Copyright (C) 2006-2008 Christian M. Zmasek
   6 # License::    GNU Lesser General Public License (LGPL)
   7 #
   8 # decoration of phylogenies with sequence/species names and domain architectures
   9 #
  10 # $Id: phylogenies_decorator.rb,v 1.34 2010/12/13 19:00:11 cmzmasek Exp $
  11 #
  12 # Environment variable FORESTER_HOME needs to point to the appropriate
  13 # directory (e.g. setenv FORESTER_HOME $HOME/SOFTWARE_DEV/ECLIPSE_WORKSPACE/forester/)
  14
  15 require 'lib/evo/util/constants'
  16 require 'lib/evo/util/util'
  17 require 'lib/evo/util/command_line_arguments'
  18
  19 require 'date'
  20
  21 module Evoruby
  22
  23   class PhylogeniesDecorator
  24
  25     #DECORATOR_OPTIONS_SEQ_NAMES = '-r=1 -mdn'
  26     #DECORATOR_OPTIONS_SEQ_NAMES = '-p -t -sn'
  27     DECORATOR_OPTIONS_SEQ_NAMES = '-p -t -tc -mp -or'
  28     # -mdn is a hidden expert option to rename e.g. "6_ORYLA3" to "6_[3]_ORYLA"
  29     #DECORATOR_OPTIONS_SEQ_NAMES = '-sn -r=1'
  30     #DECORATOR_OPTIONS_DOMAINS = '-r=1'
  31     DECORATOR_OPTIONS_DOMAINS = '-p -t'
  32     IDS_MAPFILE_SUFFIX        = '.nim'
  33     DOMAINS_MAPFILE_SUFFIX    = '.dff'
  34     SLEEP_TIME                = 0.1
  35     REMOVE_NI                 = true
  36     TMP_FILE_1                  = '___PD1___'
  37     TMP_FILE_2                  = '___PD2___'
  38     LOG_FILE                  = '00_phylogenies_decorator.log'
  39     FORESTER_HOME             = ENV[Constants::FORESTER_HOME_ENV_VARIABLE]
  40     JAVA_HOME                 = ENV[Constants::JAVA_HOME_ENV_VARIABLE]
  41
  42     PRG_NAME       = "phylogenies_decorator"
  43     PRG_DATE       = "2012.10.11"
  44     PRG_DESC       = "decoration of phylogenies with sequence/species names and domain architectures"
  45     PRG_VERSION    = "1.02"
  46     COPYRIGHT      = "2012 Christian M Zmasek"
  47     CONTACT        = "phylosoft@gmail.com"
  48     WWW            = "https://sites.google.com/site/cmzmasek/home/software/forester"
  49
  50
  51     HELP_OPTION_1       = "help"
  52     HELP_OPTION_2       = "h"
  53
  54     NL = Constants::LINE_DELIMITER
  55
  56     def run
  57
  58       Util.print_program_information( PRG_NAME,
  59         PRG_VERSION,
  60         PRG_DESC,
  61         PRG_DATE,
  62         COPYRIGHT,
  63         CONTACT,
  64         WWW,
  65         STDOUT )
  66
  67       if ( ARGV == nil || ARGV.length > 3 || ARGV.length < 2  )
  68         print_help
  69         exit( -1 )
  70       end
  71
  72       if FORESTER_HOME == nil || FORESTER_HOME.length < 1
  73         Util.fatal_error( PRG_NAME, "apparently environment variable #{Constants::FORESTER_HOME_ENV_VARIABLE} has not been set" )
  74       end
  75       if JAVA_HOME == nil ||  JAVA_HOME.length < 1
  76         Util.fatal_error( PRG_NAME, "apparently environment variable #{Constants::JAVA_HOME_ENV_VARIABLE} has not been set" )
  77       end
  78
  79       if !File.exist?( FORESTER_HOME )
  80         Util.fatal_error( PRG_NAME, '[' + FORESTER_HOME + '] does not exist' )
  81       end
  82       if !File.exist?( JAVA_HOME )
  83         Util.fatal_error( PRG_NAME, '[' + JAVA_HOME + '] does not exist' )
  84       end
  85
  86       decorator = JAVA_HOME + '/bin/java -cp ' + FORESTER_HOME + '/java/forester.jar org.forester.application.decorator'
  87
  88       begin
  89         cla = CommandLineArguments.new( ARGV )
  90       rescue ArgumentError => e
  91         Util.fatal_error( PRG_NAME, "error: " + e.to_s )
  92       end
  93
  94       if ( cla.is_option_set?( HELP_OPTION_1 ) ||
  95            cla.is_option_set?( HELP_OPTION_2 ) )
  96         print_help
  97         exit( 0 )
  98       end
  99
 100       if File.exist?( LOG_FILE )
 101         Util.fatal_error( PRG_NAME, 'logfile [' + LOG_FILE + '] already exists' )
 102       end
 103
 104       in_suffix = cla.get_file_name( 0 )
 105       out_suffix = cla.get_file_name( 1 )
 106
 107       log = String.new
 108
 109       now = DateTime.now
 110       log << "Program              : " + PRG_NAME + NL
 111       log << "Version              : " + PRG_VERSION + NL
 112       log << "Program date         : " + PRG_DATE + NL
 113       log << "Options for seq names: " + DECORATOR_OPTIONS_SEQ_NAMES + NL
 114       log << "Options for domains  : " + DECORATOR_OPTIONS_DOMAINS + NL
 115       log << "FORESTER_HOME        : " + FORESTER_HOME + NL
 116       log << "JAVA_HOME            : " + JAVA_HOME + NL + NL
 117       log << "Date/time: " + now.to_s + NL
 118       log << "Directory: " + Dir.getwd  + NL + NL
 119
 120       Util.print_message( PRG_NAME, 'input suffix     : ' + in_suffix )
 121       Util.print_message( PRG_NAME, 'output suffix    : ' + out_suffix )
 122
 123       log << 'input suffix     : ' + in_suffix + NL
 124       log << 'output suffix    : ' + out_suffix + NL
 125
 126       if ( File.exists?( TMP_FILE_1 ) )
 127         File.delete( TMP_FILE_1 )
 128       end
 129       if ( File.exists?( TMP_FILE_2 ) )
 130         File.delete( TMP_FILE_2 )
 131       end
 132
 133       files = Dir.entries( "." )
 134
 135       counter = 0
 136
 137       files.each { | phylogeny_file |
 138         if ( !File.directory?( phylogeny_file ) &&
 139              phylogeny_file !~ /^\./ &&
 140              phylogeny_file !~ /^00/ &&
 141              phylogeny_file !~ /#{out_suffix}$/ &&
 142              phylogeny_file =~ /#{in_suffix}$/ )
 143           begin
 144             Util.check_file_for_readability( phylogeny_file )
 145           rescue ArgumentError
 146             Util.fatal_error( PRG_NAME, 'can not read from: ' + phylogeny_file + ': '+ $! )
 147           end
 148
 149           counter += 1
 150
 151           outfile = phylogeny_file.sub( /#{in_suffix}$/, out_suffix )
 152
 153           if REMOVE_NI
 154             outfile = outfile.sub( /_ni_/, '_' )
 155           end
 156
 157           if File.exists?( outfile )
 158             msg = counter.to_s + ': ' + phylogeny_file + ' -> ' +  outfile +
 159              ' : already exists, skipping'
 160             Util.print_message( PRG_NAME, msg  )
 161             log << msg + NL
 162             next
 163           end
 164
 165           Util.print_message( PRG_NAME, counter.to_s + ': ' + phylogeny_file + ' -> ' +  outfile )
 166           log << counter.to_s + ': ' + phylogeny_file + ' -> ' +  outfile + NL
 167
 168           phylogeny_id = get_id( phylogeny_file )
 169
 170           ids_mapfile_name = nil
 171           domains_mapfile_name = nil
 172           seqs_file_name = nil
 173
 174           ids_mapfile_name = get_file( files, phylogeny_id, IDS_MAPFILE_SUFFIX )
 175           domains_mapfile_name = get_file( files, phylogeny_id, DOMAINS_MAPFILE_SUFFIX )
 176           seqs_file_name = get_seq_file( files, phylogeny_id )
 177
 178
 179           begin
 180             Util.check_file_for_readability( domains_mapfile_name )
 181           rescue ArgumentError
 182             Util.fatal_error( PRG_NAME, 'failed to read from [#{domains_mapfile_name}]: ' + $! )
 183           end
 184
 185           begin
 186             Util.check_file_for_readability( ids_mapfile_name )
 187           rescue ArgumentError
 188             Util.fatal_error( PRG_NAME, 'failed to read from [#{ids_mapfile_name}]: ' + $! )
 189           end
 190
 191           begin
 192             Util.check_file_for_readability( seqs_file_name  )
 193           rescue ArgumentError
 194             Util.fatal_error( PRG_NAME, 'failed to read from [#{seqs_file_name }]: ' + $! )
 195           end
 196
 197           cmd = decorator +
 198            ' -p -f=m ' + phylogeny_file + ' ' +
 199            seqs_file_name  + ' ' + TMP_FILE_1
 200           puts cmd
 201           execute_cmd( cmd, log )
 202
 203           cmd = decorator + ' ' + DECORATOR_OPTIONS_DOMAINS + ' ' +
 204            '-f=d ' + TMP_FILE_1 + ' ' +
 205            domains_mapfile_name + ' ' +TMP_FILE_2
 206           puts cmd
 207           execute_cmd( cmd, log )
 208
 209           cmd = decorator + ' ' +  DECORATOR_OPTIONS_SEQ_NAMES + ' ' +
 210            '-f=n ' + TMP_FILE_2 + ' ' +
 211            ids_mapfile_name + ' ' + outfile
 212           puts cmd
 213           execute_cmd( cmd, log )
 214
 215           File.delete( TMP_FILE_1 )
 216           File.delete( TMP_FILE_2 )
 217
 218         end
 219       }
 220       open( LOG_FILE, 'w' ) do | f |
 221         f.write( log )
 222       end
 223       puts
 224       Util.print_message( PRG_NAME, 'OK' )
 225       puts
 226     end # def run
 227
 228     def execute_cmd( cmd, log )
 229       log << 'excuting ' + cmd + NL
 230       IO.popen( cmd , 'r+' ) do | pipe |
 231         pipe.close_write
 232         log << pipe.read + NL + NL
 233       end
 234       sleep( SLEEP_TIME )
 235     end
 236
 237
 238     def get_id( phylogeny_file_name )
 239       phylogeny_file_name =~ /^([^_]+)/
 240       $1
 241     end
 242
 243     def get_file( files_in_dir, phylogeny_id, suffix_pattern )
 244       matching_files = Array.new
 245       matching_suffix_files = Array.new
 246       files_in_dir.each { | file |
 247
 248         if ( !File.directory?( file ) &&
 249              file !~ /^\./ &&
 250              file !~ /^00/ &&
 251              file =~ /^#{phylogeny_id}.*#{suffix_pattern}$/ )
 252           matching_files << file
 253         end
 254         if ( !File.directory?( file ) &&
 255              file !~ /^\./ &&
 256              file !~ /^00/ &&
 257              file =~ /#{suffix_pattern}$/ )
 258           matching_suffix_files << file
 259         end
 260       }
 261       if matching_files.length < 1 && matching_suffix_files.length == 1
 262         return matching_suffix_files[ 0 ]
 263       end
 264
 265       if matching_files.length < 1 && matching_suffix_files.length < 1
 266         Util.fatal_error( PRG_NAME, 'no file matching [' + phylogeny_id +
 267            '_] [' + suffix_pattern + '] present in current directory' )
 268       end
 269       if matching_files.length > 1
 270         Util.fatal_error( PRG_NAME, 'more than one file matching [' + phylogeny_id +
 271            '_] [' + suffix_pattern + '] present in current directory' )
 272       end
 273       matching_files[ 0 ]
 274     end
 275
 276     def get_seq_file( files_in_dir, phylogeny_id )
 277       matching_files = Array.new
 278
 279       files_in_dir.each { | file |
 280
 281         if ( !File.directory?( file ) &&
 282              file !~ /^\./ &&
 283              file !~ /^00/ &&
 284              file =~ /^#{phylogeny_id}.+\d$/ )
 285           matching_files << file
 286         end
 287
 288       }
 289
 290       if matching_files.length < 1
 291         Util.fatal_error( PRG_NAME, 'no seq file matching [' + phylogeny_id + '] present in current directory' )
 292       end
 293       if matching_files.length > 1
 294         Util.fatal_error( PRG_NAME, 'more than one seq file matching [' + phylogeny_id + '] present in current directory' )
 295       end
 296       matching_files[ 0 ]
 297     end
 298
 299
 300     def print_help()
 301       puts( "Usage:" )
 302       puts()
 303       puts( "  " + PRG_NAME + ".rb <suffix of intrees to be decorated> <suffix for decorated outtrees> " )
 304       puts()
 305       puts()
 306     end
 307   end # class PhylogenyiesDecorator
 308
 309 end # module Evoruby