Bio::Tools ESTScan
SummaryIncluded librariesPackage variablesSynopsisDescriptionGeneral documentationMethods
Toolbar
WebCvs
Summary
Bio::Tools::ESTScan - Results of one ESTScan run
Package variables
No package variables defined.
Included modules
Bio::Root::Root
Bio::Tools::Prediction::Exon
Symbol
Inherit
Bio::Tools::AnalysisResult
Synopsis
   $estscan = Bio::Tools::ESTScan->new(-file => 'result.estscan');
# filehandle:
$estscan = Bio::Tools::ESTScan->new( -fh => \*INPUT );
# parse the results # note: this class is-a Bio::Tools::AnalysisResult which implements # Bio::SeqAnalysisParserI, i.e., $genscan->next_feature() is the same while($gene = $estscan->next_prediction()) { # $gene is an instance of Bio::Tools::Prediction::Gene foreach my $orf ($gene->exons()) { # $orf is an instance of Bio::Tools::Prediction::Exon $cds_str = $orf->predicted_cds(); } } # essential if you gave a filename at initialization (otherwise the file # will stay open) $estscan->close();
Description
The ESTScan module provides a parser for ESTScan coding region prediction
output.
This module inherits off Bio::Tools::AnalysisResult and therefore
implements the Bio::SeqAnalysisParserI interface.
See Bio::SeqAnalysisParserI.
Methods
_initialize_state
No description
Code
analysis_methodDescriptionCode
next_featureDescriptionCode
next_predictionDescriptionCode
closeDescriptionCode
_fasta_streamDescriptionCode
Methods description
analysis_methodcode    nextTop
 Usage     : $estscan->analysis_method();
Purpose : Inherited method. Overridden to ensure that the name matches
/estscan/i.
Returns : String
Argument : n/a
next_featurecodeprevnextTop
 Title   : next_feature
Usage : while($orf = $estscan->next_feature()) {
# do something
}
Function: Returns the next gene structure prediction of the ESTScan result
file. Call this method repeatedly until FALSE is returned.
The returned object is actually a SeqFeatureI implementing object. This method is required for classes implementing the SeqAnalysisParserI interface, and is merely an alias for next_prediction() at present. Example : Returns : A Bio::Tools::Prediction::Gene object. Args :
next_predictioncodeprevnextTop
 Title   : next_prediction
Usage : while($gene = $estscan->next_prediction()) {
# do something
}
Function: Returns the next gene structure prediction of the ESTScan result
file. Call this method repeatedly until FALSE is returned.
So far, this method DOES NOT work for reverse strand predictions, even though the code looks like. Example : Returns : A Bio::Tools::Prediction::Gene object. Args :
closecodeprevnextTop
 Title   : close
Usage : $result->close()
Function: Closes the file handle associated with this result file.
Inherited method, overridden.
Example :
Returns :
Args :
_fasta_streamcodeprevnextTop
 Title   : _fasta_stream
Usage : $result->_fasta_stream()
Function: Gets/Sets the FASTA sequence IO stream for reading the contents of
the file associated with this MZEF result object.
If called for the first time, creates the stream from the filehandle if necessary. Example : Returns : Args :
Methods code
_initialize_statedescriptionprevnextTop
sub _initialize_state {
    my ($self,@args) = @_;

    # first call the inherited method!
my $make = $self->SUPER::_initialize_state(@args); if(! $self->analysis_method()) { $self->analysis_method('ESTScan'); }
}
analysis_methoddescriptionprevnextTop
sub analysis_method {
 #-------------
my ($self, $method) = @_; if($method && ($method !~ /estscan/i)) { $self->throw("method $method not supported in " . ref($self)); } return $self->SUPER::analysis_method($method);
}
next_featuredescriptionprevnextTop
sub next_feature {
    my ($self,@args) = @_;
    # even though next_prediction doesn't expect any args (and this method
# does neither), we pass on args in order to be prepared if this changes
# ever
return $self->next_prediction(@args);
}
next_predictiondescriptionprevnextTop
sub next_prediction {
    my ($self) = @_;
    my ($gene, $seq, $cds, $predobj);
    my $numins = 0;

    # predictions are in the format of FASTA sequences and can be parsed one
# at a time
$seq = $self->_fasta_stream()->next_seq(); return unless $seq; # there is a new prediction
$gene = Bio::Tools::Prediction::Gene->new('-primary' => "ORFprediction", '-source' => "ESTScan"); # score starts the description
$seq->desc() =~ /^([\d.]+)\s*(.*)/ or $self->throw("unexpected format of description: no score in " . $seq->desc()); $gene->score($1); $seq->desc($2); # strand may end the description
if($seq->desc() =~ /(.*)minus strand$/) { my $desc = $1; $desc =~ s/;\s+$//; $seq->desc($desc); $gene->strand(-1); } else { $gene->strand(1); } # check for the format: default or 'all-in-one' (option -a)
if($seq->desc() =~ /^(\d+)\s+(\d+)\s+(\d+)\s+(\d+)\s*(.*)/) { # default format
$seq->desc($5); $predobj = Bio::Tools::Prediction::Exon->new('-source' => "ESTScan", '-start' => $3, '-end' => $4); $predobj->strand($gene->strand()); $predobj->score($gene->score()); # FIXME or $1, or $2 ?
$predobj->primary_tag("InternalExon"); $predobj->seq_id($seq->display_id()); # add to gene structure object
$gene->add_exon($predobj); # add predicted CDS
$cds = $seq->seq(); $cds =~ s/[a-z]//g; # remove the deletions, but keep the insertions
$cds = Bio::PrimarySeq->new('-seq' => $cds, '-display_id' => $seq->display_id(), '-desc' => $seq->desc(), '-alphabet' => "dna"); $gene->predicted_cds($cds); $predobj->predicted_cds($cds); if($gene->strand() == -1) { $self->warn("reverse strand ORF, but unable to reverse coordinates!"); } } else { #
# All-in-one format (hopefully). This encodes the following information
# into the sequence:
# 1) untranslated regions: stretches of lower-case letters
# 2) translated regions: stretches of upper-case letters
# 3) insertions in the translated regions: capital X
# 4) deletions in the translated regions: a single lower-case letter
#
# if reverse strand ORF, save a lot of hassle by reversing the sequence
if($gene->strand() == -1) { $seq = $seq->revcom(); } my $seqstr = $seq->seq(); while($seqstr =~ /^([a-z]*)([A-Z].*)$/) { # leading 5'UTR
my $utr5 = $1; # exon + 3'UTR
my $exonseq = $2; # strip 3'UTR and following exons
if($exonseq =~ s/([a-z]{2,}.*)$//) { $seqstr = $1; } else { $seqstr = ""; } # start: take care of yielding the absolute coordinate
my $start = CORE::length($utr5) + 1; if($predobj) { $start += $predobj->end() + $numins; } # for the end coordinate, we need to subtract the insertions
$cds = $exonseq; $cds =~ s/[X]//g; my $end = $start + CORE::length($cds) - 1; # construct next exon object
$predobj = Bio::Tools::Prediction::Exon->new('-start' => $start, '-end' => $end); $predobj->source_tag("ESTScan"); $predobj->primary_tag("InternalExon"); $predobj->seq_id($seq->display_id()); $predobj->strand($gene->strand()); $predobj->score($gene->score()); # add the exon to the gene structure object
$gene->add_exon($predobj); # add the predicted CDS
$cds = $exonseq; $cds =~ s/[a-z]//g; # remove the deletions, but keep the insertions
$cds = Bio::PrimarySeq->new('-seq' => $cds, '-display_id' => $seq->display_id(), '-desc' => $seq->desc(), '-alphabet' => "dna"); # only store the first one in the overall prediction
$gene->predicted_cds($cds) unless $gene->predicted_cds(); $predobj->predicted_cds($cds); # add the predicted insertions and deletions as subfeatures
# of the exon
my $fea = undef; while($exonseq =~ /([a-zX])/g) { my $indel = $1; # start and end: start looking at the position after the
# previous feature
if($fea) { $start = $fea->start()+$numins; $start -= 1 if($fea->primary_tag() eq 'insertion'); } else { $start = $predobj->start()+$numins-1; } #print "# numins = $numins, indel = $indel, start = $start\n";
$start = index($seq->seq(), $indel, $start) + 1 - $numins; $fea = Bio::SeqFeature::Generic->new('-start' => $start, '-end' => $start); $fea->source_tag("ESTScan"); $fea->seq_id($seq->display_id()); $fea->strand($predobj->strand()); if($indel eq 'X') { # an insertion (depends on viewpoint: to get the 'real'
# CDS, a base has to be inserted, i.e., the HMMER model
# inserted a base; however, the sequencing process deleted
# a base that was there).
$fea->primary_tag("insertion"); # we need to count insertions because these are left out
# of any coordinates saved in the objects (which is correct
# because insertions change the original sequence, so
# coordinates wouldn't match)
$numins++; } else { # a deletion (depends on viewpoint: to get the 'real'
# CDS, a base has to be deleted, i.e., the HMMER model
# deleted a base; however, the sequencing process inserted
# a base that wasn't there).
$fea->primary_tag("deletion"); $fea->add_tag_value('base', $indel); } $predobj->add_sub_SeqFeature($fea); } } } return $gene;
}
closedescriptionprevnextTop
sub close {
   my ($self, @args) = @_;

   delete($self->{'_fastastream'});
   $self->SUPER::close(@args);
}
_fasta_streamdescriptionprevnextTop
sub _fasta_stream {
    my ($self, $stream) = @_;
    
    if($stream || (! exists($self->{'_fastastream'}))) {
	if(! $stream) {
	    $stream = Bio::SeqIO->new('-fh' => $self->_fh(),
				      '-format' => "fasta");
	}
	$self->{'_fastastream'} = $stream;
    }
    return $self->{'_fastastream'};
}

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 one
of the Bioperl mailing lists. 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
the bugs and their resolution. Bug reports can be submitted via the
web:
  https://redmine.open-bio.org/projects/bioperl/
AUTHOR - Hilmar LappTop
Email hlapp@gmx.net (or hilmar.lapp@pharma.novartis.com)
APPENDIXTop
The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _