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

   1 #
   2 # = lib/evo/tool/hmmscan_summary.rb - HmmscanSummary class
   3 #
   4 # Copyright::  Copyright (C) 2012 Christian M. Zmasek
   5 # License::    GNU Lesser General Public License (LGPL)
   6 #
   7 # $Id: hmmscan_parser.rb,v 1.5 2010/12/13 19:00:11 cmzmasek Exp $
   8 #
   9 # last modified: 121003
  10
  11 require 'lib/evo/util/constants'
  12 require 'lib/evo/util/util'
  13 require 'lib/evo/util/command_line_arguments'
  14 require 'lib/evo/io/parser/hmmscan_parser'
  15 require 'lib/evo/io/parser/uniprot_parser'
  16
  17 module Evoruby
  18
  19   class HmmscanSummary
  20
  21     PRG_NAME       = "hsp"
  22     PRG_VERSION    = "2.000"
  23     PRG_DESC       = "hmmscan summary"
  24     PRG_DATE       = "2012.10.19"
  25     COPYRIGHT      = "2012 Christian M Zmasek"
  26     CONTACT        = "phylosoft@gmail.com"
  27     WWW            = "www.phylosoft.org"
  28
  29     DELIMITER_OPTION              = "d"
  30     I_E_VALUE_THRESHOLD_OPTION    = "ie"
  31     FS_E_VALUE_THRESHOLD_OPTION   = "pe"
  32     HMM_FOR_PROTEIN_OUTPUT        = "m"
  33     IGNORE_DUF_OPTION             = "i"
  34     PARSE_OUT_DESCRIPITION_OPTION = "a"
  35     UNIPROT                       = "u"
  36     HELP_OPTION_1                 = "help"
  37     HELP_OPTION_2                 = "h"
  38
  39     USE_AVOID_HMMS = true
  40     AVOID_HHMS = [ "RRM_1", "RRM_2", "RRM_3", "RRM_4", "RRM_5", "RRM_6" ]
  41     LIMIT_FOR_CLOSE_DOMAINS = 20
  42
  43     def initialize
  44       @domain_counts = Hash.new
  45     end
  46
  47     def run
  48
  49       Util.print_program_information( PRG_NAME,
  50         PRG_VERSION,
  51         PRG_DESC,
  52         PRG_DATE,
  53         COPYRIGHT,
  54         CONTACT,
  55         WWW,
  56         STDOUT )
  57
  58       begin
  59         cla = CommandLineArguments.new( ARGV )
  60       rescue ArgumentError => e
  61         Util.fatal_error( PRG_NAME, "error: " + e.to_s, STDOUT )
  62       end
  63
  64       if ( cla.is_option_set?( HELP_OPTION_1 ) ||
  65            cla.is_option_set?( HELP_OPTION_2 ) )
  66         print_help
  67         exit( 0 )
  68       end
  69
  70       if ( cla.get_number_of_files != 2 )
  71         print_help
  72         exit( -1 )
  73       end
  74
  75       allowed_opts = Array.new
  76       allowed_opts.push( DELIMITER_OPTION )
  77       allowed_opts.push( I_E_VALUE_THRESHOLD_OPTION )
  78       allowed_opts.push( FS_E_VALUE_THRESHOLD_OPTION )
  79       allowed_opts.push( IGNORE_DUF_OPTION )
  80       allowed_opts.push( PARSE_OUT_DESCRIPITION_OPTION )
  81       allowed_opts.push( HMM_FOR_PROTEIN_OUTPUT )
  82        allowed_opts.push( UNIPROT )
  83
  84       disallowed = cla.validate_allowed_options_as_str( allowed_opts )
  85       if ( disallowed.length > 0 )
  86         Util.fatal_error( PRG_NAME,
  87           "unknown option(s): " + disallowed,
  88           STDOUT )
  89       end
  90
  91       inpath = cla.get_file_name( 0 )
  92       outpath = cla.get_file_name( 1 )
  93
  94       column_delimiter = "\t"
  95       if ( cla.is_option_set?( DELIMITER_OPTION ) )
  96         begin
  97           column_delimiter = cla.get_option_value( DELIMITER_OPTION )
  98         rescue ArgumentError => e
  99           Util.fatal_error( PRG_NAME, "error: " + e.to_s, STDOUT )
 100         end
 101       end
 102
 103       i_e_value_threshold = -1.0
 104       if ( cla.is_option_set?( I_E_VALUE_THRESHOLD_OPTION ) )
 105         begin
 106           i_e_value_threshold = cla.get_option_value_as_float( I_E_VALUE_THRESHOLD_OPTION )
 107         rescue ArgumentError => e
 108           Util.fatal_error( PRG_NAME, "error: " + e.to_s, STDOUT )
 109         end
 110         if ( i_e_value_threshold < 0.0 )
 111           Util.fatal_error( PRG_NAME, "attempt to use a negative i-E-value threshold", STDOUT )
 112         end
 113       end
 114
 115       fs_e_value_threshold = -1.0
 116       if ( cla.is_option_set?( FS_E_VALUE_THRESHOLD_OPTION ) )
 117         begin
 118           fs_e_value_threshold = cla.get_option_value_as_float( FS_E_VALUE_THRESHOLD_OPTION )
 119         rescue ArgumentError => e
 120           Util.fatal_error( PRG_NAME, "error: " + e.to_s, STDOUT )
 121         end
 122         if ( fs_e_value_threshold < 0.0 )
 123           Util.fatal_error( PRG_NAME, "attempt to use a negative E-value threshold", STDOUT )
 124         end
 125       end
 126
 127       hmm_for_protein_output = ""
 128       if ( cla.is_option_set?( HMM_FOR_PROTEIN_OUTPUT ) )
 129         begin
 130           hmm_for_protein_output = cla.get_option_value( HMM_FOR_PROTEIN_OUTPUT )
 131         rescue ArgumentError => e
 132           Util.fatal_error( PRG_NAME, "error: " + e.to_s, STDOUT )
 133         end
 134       end
 135
 136       uniprot = ""
 137        if ( cla.is_option_set?( UNIPROT ) )
 138         begin
 139            uniprot = cla.get_option_value( UNIPROT )
 140         rescue ArgumentError => e
 141           Util.fatal_error( PRG_NAME, "error: " + e.to_s, STDOUT )
 142         end
 143       end
 144
 145       ignore_dufs = false
 146       if ( cla.is_option_set?( IGNORE_DUF_OPTION ) )
 147         ignore_dufs = true
 148       end
 149
 150       parse_descriptions = false
 151       if ( cla.is_option_set?( PARSE_OUT_DESCRIPITION_OPTION ) )
 152         parse_descriptions = true
 153       end
 154
 155       puts()
 156       puts( "hmmpfam outputfile  : " + inpath )
 157       puts( "outputfile          : " + outpath )
 158       if ( i_e_value_threshold >= 0.0 )
 159         puts( "i-E-value threshold : " + i_e_value_threshold.to_s )
 160       else
 161         puts( "i-E-value threshold : no threshold" )
 162       end
 163       if ( parse_descriptions )
 164         puts( "parse descriptions  : true" )
 165       else
 166         puts( "parse descriptions  : false" )
 167       end
 168       if ( ignore_dufs )
 169         puts( "ignore DUFs         : true" )
 170       else
 171         puts( "ignore DUFs         : false" )
 172       end
 173       if ( column_delimiter == "\t" )
 174         puts( "column delimiter    : TAB" )
 175       else
 176         puts( "column delimiter     : " + column_delimiter )
 177       end
 178       if fs_e_value_threshold >= 0.0
 179         puts( "E-value threshold   : " + fs_e_value_threshold.to_s )
 180       else
 181         puts( "E-value threshold   : no threshold" )
 182       end
 183       if !hmm_for_protein_output.empty?
 184         puts( "HMM for proteins    : " + hmm_for_protein_output )
 185       end
 186       if !uniprot.empty?
 187         puts( "Uniprot             : " + uniprot )
 188       end
 189       puts()
 190
 191       begin
 192         parse( inpath,
 193           outpath,
 194           column_delimiter,
 195           i_e_value_threshold,
 196           ignore_dufs,
 197           parse_descriptions,
 198           fs_e_value_threshold,
 199           hmm_for_protein_output,
 200           uniprot )
 201       rescue ArgumentError, IOError => e
 202         Util.fatal_error( PRG_NAME, "error: " + e.to_s, STDOUT )
 203       end
 204       domain_counts = get_domain_counts()
 205
 206
 207       puts
 208       puts( "domain counts (considering potential i-E-value threshold and ignoring of DUFs):" )
 209       puts( "(number of different domains: " + domain_counts.length.to_s + ")" )
 210       puts
 211       puts( Util.draw_histogram( domain_counts, "#" ) )
 212       puts
 213       Util.print_message( PRG_NAME, 'OK' )
 214       puts
 215
 216     end # def run
 217
 218     private
 219
 220     # raises ArgumentError, IOError
 221     def parse( inpath,
 222         outpath,
 223         column_delimiter,
 224         i_e_value_threshold,
 225         ignore_dufs,
 226         get_descriptions,
 227         fs_e_value_threshold,
 228         hmm_for_protein_output,
 229         uniprot )
 230       Util.check_file_for_readability( inpath )
 231       Util.check_file_for_writability( outpath )
 232
 233       hmmscan_parser = HmmscanParser.new( inpath )
 234       results = hmmscan_parser.parse
 235
 236       uniprot_entries = nil
 237       if !uniprot.empty?
 238         uniprot_entries = read_uniprot( results, uniprot  )
 239       end
 240
 241       outfile = File.open( outpath, "a" )
 242
 243       query     = ""
 244       desc      = ""
 245       model     = ""
 246       env_from  = ""
 247       env_to    = ""
 248       i_e_value = ""
 249
 250       hmmscan_results_per_protein = []
 251
 252
 253
 254       prev_query = ""
 255
 256       results.each do | r |
 257         model     = r.model
 258         query     = r.query
 259         i_e_value = r.i_e_value
 260         env_from  = r.env_from
 261         env_to    = r.env_to
 262
 263         if ( ( i_e_value_threshold < 0.0 ) || ( i_e_value <= i_e_value_threshold ) ) &&
 264            ( !ignore_dufs || ( model !~ /^DUF\d+/ ) )
 265           count_model( model )
 266           outfile.print( query +
 267              column_delimiter )
 268           if ( get_descriptions )
 269             outfile.print( desc +
 270                column_delimiter )
 271           end
 272           outfile.print( model +
 273              column_delimiter +
 274              env_from.to_s +
 275              column_delimiter +
 276              env_to.to_s +
 277              column_delimiter +
 278              i_e_value.to_s )
 279           outfile.print( Constants::LINE_DELIMITER )
 280         end
 281
 282         if !hmm_for_protein_output.empty?
 283           if  !prev_query.empty? && prev_query != query
 284             if !hmmscan_results_per_protein.empty?
 285               process_hmmscan_results_per_protein( hmmscan_results_per_protein,
 286                 fs_e_value_threshold,
 287                 hmm_for_protein_output,
 288                 i_e_value_threshold )
 289             end
 290             hmmscan_results_per_protein.clear
 291           end
 292           prev_query = query
 293
 294           if USE_AVOID_HMMS
 295             if !AVOID_HHMS.include? r.model
 296               hmmscan_results_per_protein << r
 297             end
 298           else
 299             hmmscan_results_per_protein << r
 300           end
 301         end
 302       end
 303       if !hmm_for_protein_output.empty?
 304         if !hmmscan_results_per_protein.empty?
 305           process_hmmscan_results_per_protein( hmmscan_results_per_protein,
 306             fs_e_value_threshold,
 307             hmm_for_protein_output,
 308             i_e_value_threshold )
 309         end
 310       end
 311       outfile.flush()
 312       outfile.close()
 313
 314     end # def parse
 315
 316
 317      def read_uniprot( hmmscan_results, uniprot  )
 318         ids = []
 319          hmmscan_results.each do | r |
 320            ids << r.query
 321          end
 322          uniprot_parser = UniprotParser.new uniprot
 323          uniprot_entries = uniprot_parser.parse ids
 324          uniprot_entries
 325       end
 326
 327     def count_model( model )
 328       if ( @domain_counts.has_key?( model ) )
 329         count = @domain_counts[ model ].to_i
 330         count += 1
 331         @domain_counts[ model ] = count
 332       else
 333         @domain_counts[ model ] = 1
 334       end
 335     end
 336
 337     def process_hmmscan_results_per_protein( hmmscan_results_per_protein,
 338         fs_e_value_threshold,
 339         hmm_for_protein_output,
 340         i_e_value_threshold )
 341
 342       dc = 0
 343       # filter according to i-Evalue threshold
 344       # abort if fs Evalue too high
 345       hmmscan_results_per_protein_filtered = []
 346
 347       hmmscan_results_per_protein.each do | r |
 348         if r.model == hmm_for_protein_output
 349           if r.fs_e_value > fs_e_value_threshold
 350             return
 351           end
 352         end
 353         if r.i_e_value <= i_e_value_threshold
 354           hmmscan_results_per_protein_filtered << r
 355           if r.model == hmm_for_protein_output
 356             dc += 1
 357           end
 358         end
 359       end
 360
 361       if dc == 0
 362         # passed on protein E-value, failed in per domain E-values
 363         return
 364       end
 365
 366       hmmscan_results_per_protein_filtered.sort! { |r1,r2| r1.env_from <=> r2.env_from }
 367
 368       own = nil
 369       hmmscan_results_per_protein_filtered.each do | r |
 370         if r.model == hmm_for_protein_output
 371           own = r
 372         end
 373       end
 374
 375       s = ""
 376       s << own.query + "\t"
 377       s << "HUMAN" + "\t"
 378       s << own.fs_e_value.to_s + "\t"
 379       s << own.qlen.to_s + "\t"
 380       s << dc.to_s + "\t"
 381       s << hmmscan_results_per_protein_filtered.length.to_s + "\t"
 382       hmmscan_results_per_protein_filtered.each do | r |
 383         s << r.model + " "
 384       end
 385       s << "\t"
 386
 387       overview = make_overview( hmmscan_results_per_protein_filtered, hmm_for_protein_output )
 388
 389       s << overview   + "\t"
 390
 391       s << calc_linkers(  hmmscan_results_per_protein_filtered, hmm_for_protein_output )  + "\t"
 392
 393       prev_r = nil
 394       hmmscan_results_per_protein_filtered.each do | r |
 395
 396         if  prev_r != nil
 397           s << make_interdomain_sequence( r.env_from - prev_r.env_to - 1 )
 398         else
 399           s << make_interdomain_sequence( r.env_from, false )
 400         end
 401         s << r.model
 402         s << "["
 403         s << r.env_from.to_s << "-" << r.env_to.to_s
 404         s << "|ie=" << r.i_e_value.to_s
 405         s << "|ce=" << r.c_e_value.to_s
 406         s << "]"
 407         prev_r = r
 408       end
 409       s << make_interdomain_sequence( own.qlen - prev_r.env_from, false )
 410       puts s
 411     end
 412
 413
 414     def calc_linkers(  hmmscan_results_per_protein_filtered, hmm_for_protein_output )
 415       linkers = ""
 416       prev_r = nil
 417       hmmscan_results_per_protein_filtered.each do | r |
 418         if r.model == hmm_for_protein_output
 419           if  prev_r != nil
 420             linkers << ( r.env_from - prev_r.env_to - 1 ).to_s + " "
 421           end
 422           prev_r = r
 423         end
 424       end
 425       linkers
 426     end
 427
 428     def get_domain_counts()
 429       return @domain_counts
 430     end
 431
 432     def make_overview( hmmscan_results_per_protein_filtered, hmm_for_protein_output )
 433       overview = ""
 434       prev_r = nil
 435       hmmscan_results_per_protein_filtered.each do | r |
 436         if r.model == hmm_for_protein_output
 437           if prev_r == nil
 438             overview << hmm_for_protein_output
 439           else
 440             if  ( r.env_from - prev_r.env_to - 1 ) <= LIMIT_FOR_CLOSE_DOMAINS
 441               overview << "~" << hmm_for_protein_output
 442             else
 443               overview << "----" << hmm_for_protein_output
 444             end
 445           end
 446           prev_r = r
 447         end
 448       end
 449       overview
 450     end
 451
 452     def make_interdomain_sequence( d, mark_short = true )
 453       s = ""
 454       d /= 20
 455       if d >= 10
 456         s << "----//----"
 457       elsif d >= 1
 458         d.times do
 459           s << "-"
 460         end
 461       elsif mark_short
 462         s << "~"
 463       end
 464       s
 465     end
 466
 467
 468
 469     def print_help()
 470       puts( "Usage:" )
 471       puts()
 472       puts( "  " + PRG_NAME + ".rb [options] <hmmscan outputfile> <outputfile>" )
 473       puts()
 474       puts( "  options: -" + DELIMITER_OPTION + ": column delimiter for outputfile, default is TAB" )
 475       puts( "           -" + I_E_VALUE_THRESHOLD_OPTION  + ": i-E-value threshold, default is no threshold" )
 476       puts( "           -" + PARSE_OUT_DESCRIPITION_OPTION  + ": parse query description (in addition to query name)" )
 477       puts( "           -" + IGNORE_DUF_OPTION  + ": ignore DUFs" )
 478       puts( "           -" + FS_E_VALUE_THRESHOLD_OPTION  + ": E-value threshold for full protein sequences, only for protein summary" )
 479       puts( "           -" + HMM_FOR_PROTEIN_OUTPUT + ": HMM for protein summary" )
 480       puts()
 481     end
 482
 483   end # class
 484
 485 end # module Evoruby