Class: Bio::Blast::Default::Report
- Inherits:
-
Object
- Object
- Bio::Blast::Default::Report
- Defined in:
- lib/bio/appl/blast/format0.rb
Overview
Bio::Blast::Default::Report parses NCBI BLAST default output and stores information in the data. It may store some Bio::Blast::Default::Report::Iteration objects.
Defined Under Namespace
Classes: AlwaysNil, F0dbstat, HSP, Hit, Iteration
Constant Summary
- DELIMITER =
< DB
RS = "\nBLAST"
- DELIMITER_OVERRUN =
(Integer) excess read size included in DELIMITER.
5
Instance Attribute Summary (collapse)
-
- (Object) db_len
readonly
Returns the value of attribute db_len.
-
- (Object) db_num
readonly
Returns the value of attribute db_num.
-
- (Object) eff_space
readonly
Returns the value of attribute eff_space.
-
- (Object) entry_overrun
readonly
piece of next entry.
-
- (Object) expect
readonly
Returns the value of attribute expect.
-
- (Object) gap_extend
readonly
Returns the value of attribute gap_extend.
-
- (Object) gap_open
readonly
Returns the value of attribute gap_open.
-
- (Object) iterations
readonly
(PSI-BLAST) Returns iterations.
-
- (Object) matrix
readonly
Returns the value of attribute matrix.
-
- (Object) num_hits
readonly
Returns the value of attribute num_hits.
-
- (Object) posted_date
readonly
Returns the value of attribute posted_date.
-
- (Object) sc_match
readonly
Returns the value of attribute sc_match.
-
- (Object) sc_mismatch
readonly
Returns the value of attribute sc_mismatch.
Class Method Summary (collapse)
-
+ (Object) delegate_to_f0dbstat(*names)
Defines attributes which delegate to @f0dbstat objects.
-
+ (Object) open(filename, *mode)
Opens file by using Bio::FlatFile.open.
Instance Method Summary (collapse)
-
- (Boolean) converged?
(PSI-BLAST) Same as iterations.last.converged?.
-
- (Object) db
Returns the name (filename or title) of the database.
-
- (Object) each_hit
(also: #each)
Iterates over each hit of the last iteration.
-
- (Object) each_iteration
(PSI-BLAST) Iterates over each iteration.
-
- (Object) entropy
Same as iterations.last.entropy.
-
- (Object) gapped_entropy
Same as iterations.last.gapped_entropy.
-
- (Object) gapped_kappa
Same as iterations.last.gapped_kappa.
-
- (Object) gapped_lambda
Same as iterations.last.gapped_lambda.
-
- (Object) hits
Same as iterations.last.hits.
-
- (Report) initialize(*arg)
constructor
def.
-
- (Object) kappa
Same as iterations.last.kappa.
-
- (Object) lambda
Same as iterations.last.lambda.
-
- (Object) message
(PSI-BLAST) Same as iterations.last.message.
-
- (Object) pattern
(PHI-BLAST) Same as iterations.first.pattern.
-
- (Object) pattern_positions
(PHI-BLAST) Same as iterations.first.pattern_positions.
-
- (Object) program
Returns program name.
-
- (Object) query_def
Returns definition of the query.
-
- (Object) query_len
Returns length of the query.
-
- (Object) reference
Returns the bibliography reference of the BLAST software.
-
- (Object) references
Returns the bibliography references of the BLAST software.
-
- (Object) to_s
Returns whole entry as a string.
-
- (Object) version
Returns version of the program.
-
- (Object) version_date
Returns released date of the program.
-
- (Object) version_number
Returns version number string of the program.
Constructor Details
- (Report) initialize(*arg)
def
53 54 55 |
# File 'lib/bio/appl/blast/format0.rb', line 53 def initialize(*arg) raise 'cannot use StringScanner_R' end |
Instance Attribute Details
- (Object) db_len (readonly)
Returns the value of attribute db_len
102 103 104 |
# File 'lib/bio/appl/blast/format0.rb', line 102 def db_len @db_len end |
- (Object) db_num (readonly)
Returns the value of attribute db_num
98 99 100 |
# File 'lib/bio/appl/blast/format0.rb', line 98 def db_num @db_num end |
- (Object) eff_space (readonly)
Returns the value of attribute eff_space
110 111 112 |
# File 'lib/bio/appl/blast/format0.rb', line 110 def eff_space @eff_space end |
- (Object) entry_overrun (readonly)
piece of next entry. Bio::FlatFile uses it.
65 66 67 |
# File 'lib/bio/appl/blast/format0.rb', line 65 def entry_overrun @entry_overrun end |
- (Object) expect (readonly)
Returns the value of attribute expect
134 135 136 |
# File 'lib/bio/appl/blast/format0.rb', line 134 def expect @expect end |
- (Object) gap_extend (readonly)
Returns the value of attribute gap_extend
130 131 132 |
# File 'lib/bio/appl/blast/format0.rb', line 130 def gap_extend @gap_extend end |
- (Object) gap_open (readonly)
Returns the value of attribute gap_open
126 127 128 |
# File 'lib/bio/appl/blast/format0.rb', line 126 def gap_open @gap_open end |
- (Object) iterations (readonly)
(PSI-BLAST) Returns iterations. It returns an array of Bio::Blast::Default::Report::Iteration class. Note that normal blastall result usually contains one iteration.
71 72 73 |
# File 'lib/bio/appl/blast/format0.rb', line 71 def iterations @iterations end |
- (Object) matrix (readonly)
Returns the value of attribute matrix
114 115 116 |
# File 'lib/bio/appl/blast/format0.rb', line 114 def matrix @matrix end |
- (Object) num_hits (readonly)
Returns the value of attribute num_hits
138 139 140 |
# File 'lib/bio/appl/blast/format0.rb', line 138 def num_hits @num_hits end |
- (Object) posted_date (readonly)
Returns the value of attribute posted_date
106 107 108 |
# File 'lib/bio/appl/blast/format0.rb', line 106 def posted_date @posted_date end |
- (Object) sc_match (readonly)
Returns the value of attribute sc_match
118 119 120 |
# File 'lib/bio/appl/blast/format0.rb', line 118 def sc_match @sc_match end |
- (Object) sc_mismatch (readonly)
Returns the value of attribute sc_mismatch
122 123 124 |
# File 'lib/bio/appl/blast/format0.rb', line 122 def sc_mismatch @sc_mismatch end |
Class Method Details
+ (Object) delegate_to_f0dbstat(*names)
Defines attributes which delegate to @f0dbstat objects.
90 91 92 93 94 |
# File 'lib/bio/appl/blast/format0.rb', line 90 def self.delegate_to_f0dbstat(*names) names.each do |x| module_eval("def #{x}; @f0dbstat.#{x}; end") end end |
+ (Object) open(filename, *mode)
Opens file by using Bio::FlatFile.open.
48 49 50 |
# File 'lib/bio/appl/blast/format0.rb', line 48 def self.open(filename, *mode) Bio::FlatFile.open(self, filename, *mode) end |
Instance Method Details
- (Boolean) converged?
(PSI-BLAST) Same as iterations.last.converged?. Returns true if the last iteration is converged, otherwise, returns false.
221 222 223 |
# File 'lib/bio/appl/blast/format0.rb', line 221 def converged? @iterations.last.converged? end |
- (Object) db
Returns the name (filename or title) of the database.
245 246 247 248 249 250 251 252 253 254 |
# File 'lib/bio/appl/blast/format0.rb', line 245 def db unless defined?(@db) if /Database *\: *(.*)/m =~ @f0database then a = $1.split(/^/) a.pop if a.size > 1 @db = a.collect { |x| x.sub(/\s+\z/, '') }.join(' ') end end #unless @db end |
- (Object) each_hit Also known as: each
Iterates over each hit of the last iteration. Same as iterations.last.each_hit. Yields a Bio::Blast::Default::Report::Hit object. This is very useful in most cases, e.g. for blastall results.
196 197 198 199 200 |
# File 'lib/bio/appl/blast/format0.rb', line 196 def each_hit @iterations.last.each do |x| yield x end end |
- (Object) each_iteration
(PSI-BLAST) Iterates over each iteration. Same as iterations.each. Yields a Bio::Blast::Default::Report::Iteration object.
186 187 188 189 190 |
# File 'lib/bio/appl/blast/format0.rb', line 186 def each_iteration @iterations.each do |x| yield x end end |
- (Object) entropy
Same as iterations.last.entropy.
146 |
# File 'lib/bio/appl/blast/format0.rb', line 146 def entropy; @iterations.last.entropy; end |
- (Object) gapped_entropy
Same as iterations.last.gapped_entropy.
153 |
# File 'lib/bio/appl/blast/format0.rb', line 153 def gapped_entropy; @iterations.last.gapped_entropy; end |
- (Object) gapped_kappa
Same as iterations.last.gapped_kappa.
149 |
# File 'lib/bio/appl/blast/format0.rb', line 149 def gapped_kappa; @iterations.last.gapped_kappa; end |
- (Object) gapped_lambda
Same as iterations.last.gapped_lambda.
151 |
# File 'lib/bio/appl/blast/format0.rb', line 151 def gapped_lambda; @iterations.last.gapped_lambda; end |
- (Object) hits
Same as iterations.last.hits. Returns the last iteration's hits. Returns an array of Bio::Blast::Default::Report::Hit object. This is very useful in most cases, e.g. for blastall results.
207 208 209 |
# File 'lib/bio/appl/blast/format0.rb', line 207 def hits @iterations.last.hits end |
- (Object) kappa
Same as iterations.last.kappa.
142 |
# File 'lib/bio/appl/blast/format0.rb', line 142 def kappa; @iterations.last.kappa; end |
- (Object) lambda
Same as iterations.last.lambda.
144 |
# File 'lib/bio/appl/blast/format0.rb', line 144 def lambda; @iterations.last.lambda; end |
- (Object) message
(PSI-BLAST) Same as iterations.last.message.
213 214 215 |
# File 'lib/bio/appl/blast/format0.rb', line 213 def @iterations.last. end |
- (Object) pattern
(PHI-BLAST) Same as iterations.first.pattern. Note that it returns the FIRST iteration's value.
173 |
# File 'lib/bio/appl/blast/format0.rb', line 173 def pattern; @iterations.first.pattern; end |
- (Object) pattern_positions
(PHI-BLAST) Same as iterations.first.pattern_positions. Note that it returns the FIRST iteration's value.
178 179 180 |
# File 'lib/bio/appl/blast/format0.rb', line 178 def pattern_positions @iterations.first.pattern_positions end |
- (Object) program
Returns program name.
156 |
# File 'lib/bio/appl/blast/format0.rb', line 156 def program; format0_parse_header; @program; end |
- (Object) query_def
Returns definition of the query.
168 |
# File 'lib/bio/appl/blast/format0.rb', line 168 def query_def; format0_parse_query; @query_def; end |
- (Object) query_len
Returns length of the query.
165 |
# File 'lib/bio/appl/blast/format0.rb', line 165 def query_len; format0_parse_query; @query_len; end |
- (Object) reference
Returns the bibliography reference of the BLAST software. Note that this method shows only the first reference. When you want to get additional references, you can use references method.
229 230 231 |
# File 'lib/bio/appl/blast/format0.rb', line 229 def reference references[0] end |
- (Object) references
Returns the bibliography references of the BLAST software. Returns an array of strings.
235 236 237 238 239 240 241 242 |
# File 'lib/bio/appl/blast/format0.rb', line 235 def references unless defined?(@references) @references = @f0references.collect do |x| x.to_s.gsub(/\s+/, ' ').strip end end #unless @references end |
- (Object) to_s
Returns whole entry as a string.
74 |
# File 'lib/bio/appl/blast/format0.rb', line 74 def to_s; @entry; end |
- (Object) version
Returns version of the program.
158 |
# File 'lib/bio/appl/blast/format0.rb', line 158 def version; format0_parse_header; @version; end |
- (Object) version_date
Returns released date of the program.
162 |
# File 'lib/bio/appl/blast/format0.rb', line 162 def version_date; format0_parse_header; @version_date; end |
- (Object) version_number
Returns version number string of the program.
160 |
# File 'lib/bio/appl/blast/format0.rb', line 160 def version_number; format0_parse_header; @version_number; end |