Class: Bio::Blast::Report::Iteration

Inherits:
Object
  • Object
show all
Defined in:
lib/bio/appl/blast/report.rb

Overview

Bio::Blast::Report::Iteration

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Iteration

Returns a new instance of Iteration.



219
220
221
222
223
224
 
# File 'lib/bio/appl/blast/report.rb', line 219

def initialize
  @message = nil
  @statistics = {}
  @num = 1
  @hits = []
end

Instance Attribute Details

#hits ⇒ Object (readonly)

Returns an Array of Bio::Blast::Report::Hit objects.



226
227
228
 
# File 'lib/bio/appl/blast/report.rb', line 226

def hits
  @hits
end

#message ⇒ Object

Returns a String (or nil) containing execution message (typically “CONVERGED”).



238
239
240
 
# File 'lib/bio/appl/blast/report.rb', line 238

def message
  @message
end

#num ⇒ Object

Returns the number of iteration counts.



234
235
236
 
# File 'lib/bio/appl/blast/report.rb', line 234

def num
  @num
end

#query_def ⇒ Object

query definition, only available for new BLAST XML format



251
252
253
 
# File 'lib/bio/appl/blast/report.rb', line 251

def query_def
  @query_def
end

#query_id ⇒ Object

query ID, only available for new BLAST XML format



248
249
250
 
# File 'lib/bio/appl/blast/report.rb', line 248

def query_id
  @query_id
end

#query_len ⇒ Object

query length, only available for new BLAST XML format



254
255
256
 
# File 'lib/bio/appl/blast/report.rb', line 254

def query_len
  @query_len
end

#statistics ⇒ Object (readonly)

Returns a Hash containing execution statistics. Valid keys are: ‘db-len’, ‘db-num’, ‘eff-space’, ‘entropy’, ‘hsp-len’, ‘kappa’, ‘lambda’



231
232
233
 
# File 'lib/bio/appl/blast/report.rb', line 231

def statistics
  @statistics
end

Instance Method Details

#each ⇒ Object

Iterates on each Bio::Blast::Report::Hit object.



241
242
243
244
245
 
# File 'lib/bio/appl/blast/report.rb', line 241

def each
  @hits.each do |x|
    yield x
  end
end