Summary

Bio::SeqFeature::Similarity - A sequence feature based on similarity

Package variables

Included modules

Inherit

Bio::SeqFeature::Generic

Synopsis

    # obtain a similarity feature somehow
    print "significance: ", $sim_fea->significance(), "\n";
    print "bit score: ", $sim_fea->bits(), "\n";
    print "score: ", $sim_fea->score(), "\n";
    print "fraction of identical residues: ", $sim_fea->frac_identical(), "\n";

Description

This module is basically a sequence features based on similarity, and therefore
has support for measures assessing the similarity.
Everything else is inherited from Bio::SeqFeature::Generic.

Methods

Methods description

 Title   : significance
 Usage   : $evalue = $obj->significance();
           $obj->significance($evalue);
 Function: 
 Returns : 
 Args    :

 Title   : bits
 Usage   : $bits = $obj->bits();
           $obj->bits($value);
 Function: 
 Returns : 
 Args    :

 Title   : frac_identical
 Usage   : $fracid = $obj->frac_identical();
           $obj->frac_identical($value);
 Function: 
 Returns : 
 Args    :

 Title   : seqlength
 Usage   : $len = $obj->seqlength();
           $obj->seqlength($len);
 Function: 
 Returns : 
 Args    :

 Title   : seqdesc
 Usage   : $desc = $obj->seqdesc();
           $obj->seqdesc($desc);
 Function: At present this method is a shorthand for 
           $obj->annotation()->description().

           Note that this is not stored in the tag system and hence will
           not be included in the return value of gff_string().
 Returns : 
 Args    :

Methods code

sub new {

    my ( $caller, @args) = @_;   
    my ($self) = $caller->SUPER::new(@args); 

    my ($evalue, $bits, $frac,$seqlen,$seqdesc) =
	$self->_rearrange([qw(EXPECT
			      BITS
			      FRAC
			      SEQDESC
			      SEQLENGTH				      
			      )],@args);

    $evalue && $self->significance($evalue);
    $bits   && $self->bits($bits);
    $frac   && $self->frac_identical($frac);
    $seqlen && $self->seqlength($seqlen);
    $seqdesc && $self->seqdesc($seqdesc);
    $self->primary_tag('similarity') unless( defined $self->primary_tag() );
    $self->strand(0) unless( defined $self->strand() );

    return $self;

}

sub significance {

    my ($self, $value) = @_;

    return $self->_tag_value('signif', $value);

}

sub bits {

    my ($self, $value) = @_;

    return $self->_tag_value('Bits', $value);

}

sub frac_identical {

    my ($self, $value) = @_;

    return $self->_tag_value('FracId', $value);

}

sub seqlength {

    my ($self, $value) = @_;

    return $self->_tag_value('SeqLength', $value);

}

sub seqdesc {

    my ($self, $value) = @_;

    return $self->annotation()->description();

}

General documentation

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://bio.perl.org/MailList.html             - About the mailing lists

Report bugs to the Bioperl bug tracking system to help us keep track
the bugs and their resolution.
Bug reports can be submitted via email or the web:

  bioperl-bugs@bio.perl.org
  http://bio.perl.org/bioperl-bugs/

Email hlapp@gmx.net or hilmar.lapp@pharma.novartis.com
Describe contact details here

The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _