Class: Bio::ClustalW::Report

Inherits:
DB show all
Defined in:
lib/bio/appl/clustalw/report.rb

Overview

CLUSTAL W result data (*.aln file) parser class.

Constant Summary collapse

DELIMITER =

Delimiter of each entry. Bio::FlatFile uses it. In Bio::ClustalW::Report, it it nil (1 entry 1 file).

nil

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from DB

#entry_id, #exists?, #fetch, #get, open, #tags

Constructor Details

#initialize(str, seqclass = nil) ⇒ Report

Creates new instance. str should be a CLUSTAL format string. seqclass should on of following:

  • Class: Bio::Sequence::AA, Bio::Sequence::NA, …

  • String: ‘PROTEIN’, ‘DNA’, …



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/bio/appl/clustalw/report.rb', line 43

def initialize(str, seqclass = nil)
  @raw = str
  @align = nil
  @match_line = nil
  @header = nil
  case seqclass
  when /PROTEIN/i
    @seqclass = Bio::Sequence::AA
  when /[DR]NA/i
    @seqclass = Bio::Sequence::NA
  else
    if seqclass.is_a?(Module) then
      @seqclass = seqclass
    else
      @seqclass = Bio::Sequence
    end
  end
end

Instance Attribute Details

#raw ⇒ Object (readonly)

string of whole result



62
63
64
 
# File 'lib/bio/appl/clustalw/report.rb', line 62

def raw
  @raw
end

#seqclass ⇒ Object (readonly)

sequence class (one of Bio::Sequence, Bio::Sequence::NA, Bio::Sequence::AA, …)



66
67
68
 
# File 'lib/bio/appl/clustalw/report.rb', line 66

def seqclass
  @seqclass
end

Instance Method Details

#align ⇒ Object

This will be deprecated. Instead, please use alignment.

Gets an multiple alignment. Returns a Bio::Alignment object.



93
94
95
96
 
# File 'lib/bio/appl/clustalw/report.rb', line 93

def align
  warn "Bio::ClustalW#align will be deprecated. Please use \'alignment\'."
  alignment
end

#alignment ⇒ Object

Gets an multiple alignment. Returns a Bio::Alignment object.



84
85
86
87
 
# File 'lib/bio/appl/clustalw/report.rb', line 84

def alignment
  do_parse() unless @align
  @align
end

#header ⇒ Object

Shows first line of the result data, for example, ‘CLUSTAL W (1.82) multiple sequence alignment’. Returns a string.



71
72
73
 
# File 'lib/bio/appl/clustalw/report.rb', line 71

def header
  @header or (do_parse or @header)
end

#match_line ⇒ Object

Shows “match line” of CLUSTAL’s alignment result, for example, ‘:* :* .* * .::. ** :* . * . ’. Returns a string.



78
79
80
 
# File 'lib/bio/appl/clustalw/report.rb', line 78

def match_line
  @match_line or (do_parse or @match_line)
end

#to_a ⇒ Object

Compatibility note: Behavior of the method will be changed in the future.

Gets an array of the sequences. Returns an array of Bio::FastaFormat objects.



112
113
114
 
# File 'lib/bio/appl/clustalw/report.rb', line 112

def to_a
  alignment.to_fastaformat_array
end

#to_fasta(*arg) ⇒ Object

This will be deprecated. Instead, please use alignment.output_fasta.

Gets an fasta-format string of the sequences. Returns a string.



102
103
104
105
 
# File 'lib/bio/appl/clustalw/report.rb', line 102

def to_fasta(*arg)
  warn "Bio::ClustalW::report#to_fasta is deprecated. Please use \'alignment.output_fasta\'"
  alignment.output_fasta(*arg)
end