Bio::SearchIO blasttable
SummaryIncluded librariesPackage variablesSynopsisDescriptionGeneral documentationMethods
Toolbar
WebCvs
Summary
Bio::SearchIO::blasttable - Driver module for SearchIO for parsing NCBI -m 8/9 format
Package variables
No package variables defined.
Included modules
Bio::Search::HSP::HSPFactory
Bio::Search::Hit::HitFactory
Bio::Search::Result::ResultFactory
Inherit
Bio::SearchIO
Synopsis
  # do not use this module directly
use Bio::SearchIO;
my $parser = Bio::SearchIO->new(-file => $file,
-format => 'blasttable');
while( my $result = $parser->next_result ) { }
Description
This module will support parsing NCBI -m 8 or -m 9 tabular output
and WU-BLAST -mformat 2 or -mformat 3 tabular output.
Methods
_initialize
No description
Code
next_resultDescriptionCode
start_elementDescriptionCode
end_elementDescriptionCode
elementDescriptionCode
charactersDescriptionCode
_modeDescriptionCode
within_elementDescriptionCode
in_elementDescriptionCode
start_documentDescriptionCode
end_documentDescriptionCode
result_countDescriptionCode
program_nameDescriptionCode
_will_handleDescriptionCode
Methods description
next_resultcode    nextTop
 Title   : next_result
Usage : my $result = $parser->next_result
Function: Parse the next result from the data stream
Returns : Bio::Search::Result::ResultI
Args : none
start_elementcodeprevnextTop
 Title   : start_element
Usage : $eventgenerator->start_element
Function: Handles a start element event
Returns : none
Args : hashref with at least 2 keys 'Data' and 'Name'
end_elementcodeprevnextTop
 Title   : start_element
Usage : $eventgenerator->end_element
Function: Handles an end element event
Returns : none
Args : hashref with at least 2 keys 'Data' and 'Name'
elementcodeprevnextTop
 Title   : element
Usage : $eventhandler->element({'Name' => $name, 'Data' => $str});
Function: Convience method that calls start_element, characters, end_element
Returns : none
Args : Hash ref with the keys 'Name' and 'Data'
characterscodeprevnextTop
 Title   : characters
Usage : $eventgenerator->characters($str)
Function: Send a character events
Returns : none
Args : string
_modecodeprevnextTop
 Title   : _mode
Usage : $obj->_mode($newval)
Function:
Example :
Returns : value of _mode
Args : newvalue (optional)
within_elementcodeprevnextTop
 Title   : within_element
Usage : if( $eventgenerator->within_element($element) ) {}
Function: Test if we are within a particular element
This is different than 'in' because within can be tested
for a whole block.
Returns : boolean
Args : string element name
in_elementcodeprevnextTop
 Title   : in_element
Usage : if( $eventgenerator->in_element($element) ) {}
Function: Test if we are in a particular element
This is different than 'in' because within can be tested
for a whole block.
Returns : boolean
Args : string element name
start_documentcodeprevnextTop
 Title   : start_document
Usage : $eventgenerator->start_document
Function: Handles a start document event
Returns : none
Args : none
end_documentcodeprevnextTop
 Title   : end_document
Usage : $eventgenerator->end_document
Function: Handles an end document event
Returns : Bio::Search::Result::ResultI object
Args : none
result_countcodeprevnextTop
 Title   : result_count
Usage : my $count = $searchio->result_count
Function: Returns the number of results we have processed
Returns : integer
Args : none
program_namecodeprevnextTop
 Title   : program_name
Usage : $obj->program_name($newval)
Function: Get/Set the program name
Returns : value of program_name (a scalar)
Args : on set, new value (a scalar or undef, optional)
_will_handlecodeprevnextTop
 Title   : _will_handle
Usage : Private method. For internal use only.
if( $self->_will_handle($type) ) { ... }
Function: Provides an optimized way to check whether or not an element of a
given type is to be handled.
Returns : Reference to EventHandler object if the element type is to be handled.
undef if the element type is not to be handled.
Args : string containing type of element.
Optimizations:
  1
  Using the cached pointer to the EventHandler to minimize repeated
lookups.
  2
  Caching the will_handle status for each type that is encountered so
that it only need be checked by calling
handler->will_handle($type) once.
This does not lead to a major savings by itself (only 5-10%). In
combination with other optimizations, or for large parse jobs, the
savings good be significant.
To test against the unoptimized version, remove the parentheses from
around the third term in the ternary " ? : " operator and add two
calls to $self->_eventHandler().
Methods code
_initializedescriptionprevnextTop
sub _initialize {
    my ($self,@args) = @_;
    $self->SUPER::_initialize(@args);

    my ($pname) = $self->_rearrange([qw(PROGRAM_NAME)],
				    @args);
    $self->program_name($pname || $DefaultProgramName);
    $self->_eventHandler->register_factory('result', Bio::Search::Result::ResultFactory->new(-type => 'Bio::Search::Result::GenericResult'));
    $self->_eventHandler->register_factory('hit', Bio::Search::Hit::HitFactory->new(-type => 'Bio::Search::Hit::GenericHit'));
    $self->_eventHandler->register_factory('hsp', Bio::Search::HSP::HSPFactory->new(-type => 'Bio::Search::HSP::GenericHSP'));
}
next_resultdescriptionprevnextTop
sub next_result {
   my ($self) = @_;
   my ($lastquery,$lasthit);
   local $/ = "\n";
   local $_;
   my ($alg, $ver);
   while( defined ($_ = $self->_readline) ) {
	  # WU-BLAST -mformat 3 only
if(m{^#\s((?:\S+?)?BLAST[NPX])\s(\d+\.\d+.+\d{4}\])}) { ($alg, $ver) = ($1, $2); # only one header for whole file with WU-BLAST
# so $alg and $ver won't get set properly for
# each result
$self->program_name($alg) if $alg; $self->element({'Name' => 'Result_version', 'Data' => $ver}) if $ver; next; } # -m 9 only
elsif(m{^#\s+((?:\S+?)?BLAST[NPX])\s+(.+)}) { ($alg, $ver) = ($1, $2); next; } next if /^#/ || /^\s*$/; my @fields = split; next if @fields == 1; my ($qname,$hname, $percent_id, $hsp_len, $mismatches,$gapsm, $qstart,$qend,$hstart,$hend,$evalue,$bits); # WU-BLAST-specific
my ($num_scores, $raw_score, $identities, $positives, $percent_pos, $qgap_blocks,$qgaps, $sgap_blocks, $sgaps, $qframe, $sframe); # NCBI -m8 and -m9
if (@fields == 12) { ($qname,$hname, $percent_id, $hsp_len, $mismatches,$gapsm, $qstart,$qend,$hstart,$hend,$evalue,$bits) = @fields; # NCBI -m8 and -m9, v 2.2.18+
} elsif (@fields == 13) { ($qname, $hname, $percent_id, $percent_pos, $hsp_len, $mismatches, $gapsm, $qstart,$qend,$hstart,$hend,$evalue,$bits) = @fields; } # WU-BLAST -mformat 2 and 3
elsif ((@fields == 22) or (@fields == 24)) { ($qname,$hname,$evalue,$num_scores, $bits, $raw_score, $hsp_len, $identities, $positives,$mismatches, $percent_id, $percent_pos, $qgap_blocks, $qgaps, $sgap_blocks, $sgaps, $qframe, $qstart, $qend, $sframe, $hstart,$hend,) = @fields; # we need total gaps in the alignment
$gapsm=$qgaps+$sgaps; } if (@fields == 12 || @fields == 13) { # need to determine total gaps in the alignment for NCBI output
# since NCBI reports number of gapopens and NOT total gaps
my $qlen = abs($qstart - $qend) + 1; my $querygaps = $hsp_len - $qlen; my $hlen = abs($hstart - $hend) + 1; my $hitgaps = $hsp_len - $hlen; $gapsm = $querygaps + $hitgaps; } # Remember Jim's code is 0 based
if( defined $lastquery && $lastquery ne $qname ) { $self->end_element({'Name' => 'Hit'}); $self->end_element({'Name' => 'Result'}); $self->_pushback($_); return $self->end_document; } elsif( ! defined $lastquery ) { $self->{'_result_count'}++; $self->start_element({'Name' => 'Result'}); $self->element({'Name' => 'Result_program', 'Data' => $alg || $self->program_name}); $self->element({'Name' => 'Result_version', 'Data' => $ver}) if $ver; $self->element({'Name' => 'Result_query-def', 'Data' => $qname}); $self->start_element({'Name' => 'Hit'}); $self->element({'Name' => 'Hit_id', 'Data' => $hname}); # we'll store the 1st hsp bits as the hit bits
$self->element({'Name' => 'Hit_bits', 'Data' => $bits}); # we'll store the 1st hsp value as the hit evalue
$self->element({'Name' => 'Hit_signif', 'Data' => $evalue}); } elsif( $lasthit ne $hname ) { if( $self->in_element('hit') ) { $self->end_element({'Name' => 'Hit'}); } $self->start_element({'Name' => 'Hit'}); $self->element({'Name' => 'Hit_id', 'Data' => $hname}); # we'll store the 1st hsp bits as the hit bits
$self->element({'Name' => 'Hit_bits', 'Data' => $bits}); # we'll store the 1st hsp value as the hit evalue
$self->element({'Name' => 'Hit_signif', 'Data' => $evalue}); } my $identical = $hsp_len - $mismatches - $gapsm; $self->start_element({'Name' => 'Hsp'}); $self->element({'Name' => 'Hsp_evalue', 'Data' => $evalue}); $self->element({'Name' => 'Hsp_bit-score', 'Data' => $bits}); $self->element({'Name' => 'Hsp_identity', 'Data' => $identical}); $self->element({'Name' => 'Hsp_positive', 'Data' => $positives}); $self->element({'Name' => 'Hsp_gaps', 'Data' => $gapsm}); $self->element({'Name' => 'Hsp_query-from', 'Data' => $qstart}); $self->element({'Name' => 'Hsp_query-to', 'Data' => $qend}); $self->element({'Name' => 'Hsp_hit-from', 'Data' => $hstart }); $self->element({'Name' => 'Hsp_hit-to', 'Data' => $hend }); $self->element({'Name' => 'Hsp_align-len', 'Data' => $hsp_len}); $self->end_element({'Name' => 'Hsp'}); $lastquery = $qname; $lasthit = $hname; } # fencepost
if( defined $lasthit && defined $lastquery ) { if( $self->in_element('hit') ) { $self->end_element({'Name' => 'Hit'}); } $self->end_element({'Name' => 'Result'}); return $self->end_document; }
}
start_elementdescriptionprevnextTop
sub start_element {
   my ($self,$data) = @_;
    # we currently don't care about attributes
my $nm = $data->{'Name'}; if( my $type = $MODEMAP{$nm} ) { $self->_mode($type); if( $self->_will_handle($type) ) { my $func = sprintf("start_%s",lc $type); $self->_eventHandler->$func($data->{'Attributes'}); } unshift @{$self->{'_elements'}}, $type; } if($nm eq 'Result') { $self->{'_values'} = {}; $self->{'_result'}= undef; $self->{'_mode'} = ''; }
}
end_elementdescriptionprevnextTop
sub end_element {
    my ($self,$data) = @_;
    my $nm = $data->{'Name'};
    my $rc;
    # Hsp are sort of weird, in that they end when another
# object begins so have to detect this in end_element for now
if( my $type = $MODEMAP{$nm} ) { if( $self->_will_handle($type) ) { my $func = sprintf("end_%s",lc $type); $rc = $self->_eventHandler->$func($self->{'_reporttype'}, $self->{'_values'}); } shift @{$self->{'_elements'}}; } elsif( $MAPPING{$nm} ) { if ( ref($MAPPING{$nm}) =~ /hash/i ) { my $key = (keys %{$MAPPING{$nm}})[0]; $self->{'_values'}->{$key}->{$MAPPING{$nm}->{$key}} = $self->{'_last_data'}; } else { $self->{'_values'}->{$MAPPING{$nm}} = $self->{'_last_data'}; } } else { $self->warn( "unknown nm $nm ignoring\n"); } $self->{'_last_data'} = ''; # remove read data if we are at
# end of an element
$self->{'_result'} = $rc if( $nm eq 'Result' ); return $rc;
}
elementdescriptionprevnextTop
sub element {
   my ($self,$data) = @_;
   $self->start_element($data);
   $self->characters($data);
   $self->end_element($data);
}
charactersdescriptionprevnextTop
sub characters {
   my ($self,$data) = @_;   

# deep bug fix: set $self->{'_last_data'} to undef if $$data{Data} is 
# a valid slot, whose value is undef --
# allows an undef to be propagated to object constructors and
# handled there as desired; in particular, when Hsp_postive => -conserved
# is not defined (in BLASTN, e.g.), the value of hsp's {CONSERVED} property is
# set to the value of {IDENTICAL}.
#/maj
# return unless ( defined $data->{'Data'} );
return unless ( grep /Data/, keys %$data ); if ( !defined $data->{'Data'} ) { $self->{'_last_data'} = undef; return; } if( $data->{'Data'} =~ /^\s+$/ ) { return unless $data->{'Name'} =~ /Hsp\_(midline|qseq|hseq)/; } if( $self->in_element('hsp') && $data->{'Name'} =~ /Hsp\_(qseq|hseq|midline)/ ) { $self->{'_last_hspdata'}->{$data->{'Name'}} .= $data->{'Data'}; } $self->{'_last_data'} = $data->{'Data'};
}
_modedescriptionprevnextTop
sub _mode {
    my ($self,$value) = @_;
    if( defined $value) {
	$self->{'_mode'} = $value;
    }
    return $self->{'_mode'};
}
within_elementdescriptionprevnextTop
sub within_element {
   my ($self,$name) = @_;  
   return 0 if ( ! defined $name &&
		 ! defined  $self->{'_elements'} ||
		 scalar @{$self->{'_elements'}} == 0) ;
   foreach (  @{$self->{'_elements'}} ) {
       if( $_ eq $name  ) {
	   return 1;
       } 
   }
   return 0;
}
in_elementdescriptionprevnextTop
sub in_element {
   my ($self,$name) = @_;  
   return 0 if ! defined $self->{'_elements'}->[0];
   return ( $self->{'_elements'}->[0] eq $name)
}
start_documentdescriptionprevnextTop
sub start_document {
    my ($self) = @_;
    $self->{'_lasttype'} = '';
    $self->{'_values'} = {};
    $self->{'_result'}= undef;
    $self->{'_mode'} = '';
    $self->{'_elements'} = [];
}
end_documentdescriptionprevnextTop
sub end_document {
   my ($self,@args) = @_;
   return $self->{'_result'};
}
result_countdescriptionprevnextTop
sub result_count {
    my $self = shift;
    return $self->{'_result_count'};
}
program_namedescriptionprevnextTop
sub program_name {
    my $self = shift;

    $self->{'program_name'} = shift if @_;
    return $self->{'program_name'} || $DefaultProgramName;
}
_will_handledescriptionprevnextTop
sub _will_handle {
    my ($self,$type) = @_;
    my $handler = $self->{'_handler'};
    my $will_handle = defined($self->{'_will_handle_cache'}->{$type})
                             ? $self->{'_will_handle_cache'}->{$type}
                             : ($self->{'_will_handle_cache'}->{$type} =
                               $handler->will_handle($type));

    return $will_handle ? $handler : undef;
}

1;
}
General documentation
FEEDBACKTop
Mailing ListsTop
User feedback is an integral part of the evolution of this and other
Bioperl modules. Send your comments and suggestions preferably to
the Bioperl mailing list. Your participation is much appreciated.
  bioperl-l@bioperl.org                  - General discussion
http://bioperl.org/wiki/Mailing_lists - About the mailing lists
Support Top
Please direct usage questions or support issues to the mailing list:
bioperl-l@bioperl.org
rather than to the module maintainer directly. Many experienced and
reponsive experts will be able look at the problem and quickly
address it. Please include a thorough description of the problem
with code and data examples if at all possible.
Reporting BugsTop
Report bugs to the Bioperl bug tracking system to help us keep track
of the bugs and their resolution. Bug reports can be submitted via
the web:
  https://redmine.open-bio.org/projects/bioperl/
AUTHOR - Jason StajichTop
Email jason-at-bioperl-dot-org
APPENDIXTop
The rest of the documentation details each of the object methods.
Internal methods are usually preceded with a _
newTop
 Title   : new
Usage : my $obj = Bio::SearchIO::blasttable->new();
Function: Builds a new Bio::SearchIO::blasttable object
Returns : an instance of Bio::SearchIO::blasttable
Args :