Class: ValidationTest

Inherits:
Object
  • Object
show all
Defined in:
lib/genevalidator/validation_test.rb

Overview

This is an abstract class extended by all validation classes

Direct Known Subclasses

AlignmentValidation, BlastReadingFrameValidation, DuplicationValidation, GeneMergeValidation, LengthClusterValidation, LengthRankValidation, OpenReadingFrameValidation

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (ValidationTest) initialize(type, prediction, hits = nil, *argv)

Initilizes the object Params: type: type of the predicted sequence (:nucleotide or :protein) prediction: a Sequence object representing the blast query hits: a vector of Sequence objects (usually representig the blast hits) argv: aditional arguments if needed



23
24
25
26
27
28
29
30
31
32
33
# File 'lib/genevalidator/validation_test.rb', line 23

def initialize(type, prediction, hits = nil, *argv)
  @type = type
  @prediction = prediction
  @hits = hits
  @short_header = "NewVal"
  @header = "New Validation"
  @running_time = 0
  @cli_name = "all"
  @description = "No description available."
  @validation_report = ValidationReport.new("Not enough evidence")
end

Instance Attribute Details

- (Object) cli_name

Returns the value of attribute cli_name



11
12
13
# File 'lib/genevalidator/validation_test.rb', line 11

def cli_name
  @cli_name
end

- (Object) description

Returns the value of attribute description



12
13
14
# File 'lib/genevalidator/validation_test.rb', line 12

def description
  @description
end

- (Object) header

Returns the value of attribute header



10
11
12
# File 'lib/genevalidator/validation_test.rb', line 10

def header
  @header
end

- (Object) hits

Returns the value of attribute hits



8
9
10
# File 'lib/genevalidator/validation_test.rb', line 8

def hits
  @hits
end

- (Object) prediction

Returns the value of attribute prediction



7
8
9
# File 'lib/genevalidator/validation_test.rb', line 7

def prediction
  @prediction
end

- (Object) running_time

Returns the value of attribute running_time



14
15
16
# File 'lib/genevalidator/validation_test.rb', line 14

def running_time
  @running_time
end

- (Object) short_header

Returns the value of attribute short_header



9
10
11
# File 'lib/genevalidator/validation_test.rb', line 9

def short_header
  @short_header
end

- (Object) type

Returns the value of attribute type



6
7
8
# File 'lib/genevalidator/validation_test.rb', line 6

def type
  @type
end

- (Object) validation_report

Returns the value of attribute validation_report



13
14
15
# File 'lib/genevalidator/validation_test.rb', line 13

def validation_report
  @validation_report
end

Instance Method Details

- (Object) run



35
36
37
# File 'lib/genevalidator/validation_test.rb', line 35

def run
 raise 'run method should be implemented by all classes that extend ValidationTest'
end