Bio PrimarySeqI
SummaryIncluded librariesPackage variablesSynopsisDescriptionGeneral documentationMethods
Summary
Bio::PrimarySeqI [Developers] - Interface definition for a Bio::PrimarySeq
Package variables
No package variables defined.
Included modules
Bio::Root::RootI
Bio::Tools::CodonTable
Inherit
Bio::Root::RootI
Synopsis
    # Bio::PrimarySeqI is the interface class for sequences.

    # If you are a newcomer to bioperl, you should
    # start with Bio::Seq documentation. This
    # documentation is mainly for developers using
    # Bioperl.

    # to test this is a seq object

    $obj->isa("Bio::PrimarySeqI") ||
      $obj->throw("$obj does not implement the Bio::PrimarySeqI interface");

    # accessors

    $string    = $obj->seq();
    $substring = $obj->subseq(12,50);
    $display   = $obj->display_id(); # for human display
    $id        = $obj->primary_id(); # unique id for this object,
                                     # implementation defined
    $unique_key= $obj->accession_number();
                       # unique biological id

    # object manipulation

    eval {
	$rev    = $obj->revcom();
    };
    if( $@ ) {
	$obj->throw("Could not reverse complement. ".
		    "Probably not DNA. Actual exception\n$@\n");
    }

    $trunc = $obj->trunc(12,50);

    # $rev and $trunc are Bio::PrimarySeqI compliant objects
Description
This object defines an abstract interface to basic sequence
information - for most users of the package the documentation (and
methods) in this class are not useful - this is a developers only
class which defines what methods have to be implmented by other Perl
objects to comply to the Bio::PrimarySeqI interface. Go "perldoc
Bio::Seq" or "man Bio::Seq" for more information on the main class for
sequences.
PrimarySeq is an object just for the sequence and its name(s), nothing
more. Seq is the larger object complete with features. There is a pure
perl implementation of this in Bio::PrimarySeq. If you just want to
use Bio::PrimarySeq objects, then please read that module first. This
module defines the interface, and is of more interest to people who
want to wrap their own Perl Objects/RDBs/FileSystems etc in way that
they "are" bioperl sequence objects, even though it is not using Perl
to store the sequence etc.
This interface defines what bioperl consideres necessary to "be" a
sequence, without providing an implementation of this. (An
implementation is provided in Bio::PrimarySeq). If you want to provide
a Bio::PrimarySeq 'compliant' object which in fact wraps another
object/database/out-of-perl experience, then this is the correct thing
to wrap, generally by providing a wrapper class which would inheriet
from your object and this Bio::PrimarySeqI interface. The wrapper class
then would have methods lists in the "Implementation Specific
Functions" which would provide these methods for your object.
Methods
seqDescriptionCode
subseqDescriptionCode
display_idDescriptionCode
accession_numberDescriptionCode
primary_idDescriptionCode
can_call_newDescriptionCode
alphabetDescriptionCode
moltype
No description
Code
revcomDescriptionCode
truncDescriptionCode
translateDescriptionCode
idDescriptionCode
lengthDescriptionCode
descDescriptionCode
is_circularDescriptionCode
_attempt_to_load_SeqDescriptionCode
Methods description
seqcode    nextTop
 Title   : seq
 Usage   : $string    = $obj->seq()
 Function: Returns the sequence as a string of letters. The
           case of the letters is left up to the implementer.
           Suggested cases are upper case for proteins and lower case for
           DNA sequence (IUPAC standard),
           but implementations are suggested to keep an open mind about
           case (some users... want mixed case!)
 Returns : A scalar
 Status  : Virtual
subseqcodeprevnextTop
 Title   : subseq
 Usage   : $substring = $obj->subseq(10,40);
 Function: returns the subseq from start to end, where the first base
           is 1 and the number is inclusive, ie 1-2 are the first two
           bases of the sequence

           Start cannot be larger than end but can be equal

 Returns : a string
 Args    :
 Status  : Virtual
display_idcodeprevnextTop
 Title   : display_id
 Usage   : $id_string = $obj->display_id();
 Function: returns the display id, aka the common name of the Sequence object.

           The semantics of this is that it is the most likely string
           to be used as an identifier of the sequence, and likely to
           have "human" readability.  The id is equivalent to the ID
           field of the GenBank/EMBL databanks and the id field of the
           Swissprot/sptrembl database. In fasta format, the >(\S+) is
           presumed to be the id, though some people overload the id
           to embed other information. Bioperl does not use any
           embedded information in the ID field, and people are
           encouraged to use other mechanisms (accession field for
           example, or extending the sequence object) to solve this.

           Notice that $seq->id() maps to this function, mainly for
           legacy/convience issues
 Returns : A string
 Args    : None
 Status  : Virtual
accession_numbercodeprevnextTop
 Title   : accession_number
 Usage   : $unique_biological_key = $obj->accession_number;
 Function: Returns the unique biological id for a sequence, commonly
           called the accession_number. For sequences from established
           databases, the implementors should try to use the correct
           accession number. Notice that primary_id() provides the
           unique id for the implemetation, allowing multiple objects
           to have the same accession number in a particular implementation.

           For sequences with no accession number, this method should return
           "unknown".
 Returns : A string
 Args    : None
 Status  : Virtual
primary_idcodeprevnextTop
 Title   : primary_id
 Usage   : $unique_implementation_key = $obj->primary_id;
 Function: Returns the unique id for this object in this
           implementation. This allows implementations to manage their
           own object ids in a way the implementaiton can control
           clients can expect one id to map to one object.

           For sequences with no accession number, this method should
           return a stringified memory location.

           [Note this method name is likely to change in 1.3]

 Returns : A string
 Args    : None
 Status  : Virtual
can_call_newcodeprevnextTop
 Title   : can_call_new
 Usage   : if( $obj->can_call_new ) {
             $newobj = $obj->new( %param );
	 }
 Function: can_call_new returns 1 or 0 depending
           on whether an implementation allows new
           constructor to be called. If a new constructor
           is allowed, then it should take the followed hashed
           constructor list.

           $myobject->new( -seq => $sequence_as_string,
			   -display_id  => $id
			   -accession_number => $accession
			   -alphabet => 'dna',
			   );
 Example :
 Returns : 1 or 0
 Args    :
alphabetcodeprevnextTop
 Title   : alphabet
 Usage   : if( $obj->alphabet eq 'dna' ) { /Do Something/ }
 Function: Returns the type of sequence being one of
           'dna', 'rna' or 'protein'. This is case sensitive.

           This is not called  because this would cause
           upgrade problems from the 0.5 and earlier Seq objects.

 Returns : a string either 'dna','rna','protein'. NB - the object must
           make a call of the type - if there is no type specified it
           has to guess.
 Args    : none
 Status  : Virtual
revcomcodeprevnextTop
 Title   : revcom
 Usage   : $rev = $seq->revcom()
 Function: Produces a new Bio::PrimarySeqI implementing object which
           is the reversed complement of the sequence. For protein
           sequences this throws an exception of "Sequence is a
           protein. Cannot revcom"

           The id is the same id as the original sequence, and the
           accession number is also indentical. If someone wants to
           track that this sequence has be reversed, it needs to
           define its own extensions

           To do an inplace edit of an object you can go:

           $seq = $seq->revcom();

           This of course, causes Perl to handle the garbage
           collection of the old object, but it is roughly speaking as
           efficient as an inplace edit.

 Returns : A new (fresh) Bio::PrimarySeqI object
 Args    : none
trunccodeprevnextTop
 Title   : trunc
 Usage   : $subseq = $myseq->trunc(10,100);
 Function: Provides a truncation of a sequence,

 Example :
 Returns : a fresh Bio::PrimarySeqI implementing object
 Args    : Two integers denoting first and last base of the sub-sequence.
translatecodeprevnextTop
 Title   : translate
 Usage   : $protein_seq_obj = $dna_seq_obj->translate
           #if full CDS expected:
           $protein_seq_obj = $cds_seq_obj->translate(undef,undef,undef,undef,1);
 Function:

           Provides the translation of the DNA sequence using full
           IUPAC ambiguities in DNA/RNA and amino acid codes.

           The full CDS translation is identical to EMBL/TREMBL
           database translation. Note that the trailing terminator
           character is removed before returning the translation
           object.

           Note: if you set $dna_seq_obj->verbose(1) you will get a
           warning if the first codon is not a valid initiator.

           Added way of translating using a custom codon table.  This
           has to be the final addition to this overloaded interface!

 Returns : A Bio::PrimarySeqI implementing object
 Args    : character for terminator (optional) defaults to '*'
           character for unknown amino acid (optional) defaults to 'X'
           frame (optional) valid values 0, 1, 2, defaults to 0
           codon table id (optional) defaults to 1
           complete coding sequence expected, defaults to 0 (false)
           boolean, throw exception if not complete CDS (true) or defaults to warning (false)
           codontable, a custom Bio::Tools::CodonTable object, optional
idcodeprevnextTop
 Title   : id
 Usage   : $id = $seq->id()
 Function: ID of the sequence. This should normally be (and actually is in
           the implementation provided here) just a synonym for display_id().
 Example :
 Returns : A string.
 Args    :
lengthcodeprevnextTop
 Title   : length
 Usage   : $len = $seq->length()
 Function:
 Example :
 Returns : integer representing the length of the sequence.
 Args    :
desccodeprevnextTop
 Title   : desc
 Usage   : $seq->desc($newval);
           $description = $seq->desc();
 Function: Get/set description text for a seq object
 Example :
 Returns : value of desc
 Args    : newvalue (optional)
is_circularcodeprevnextTop
 Title   : is_circular
 Usage   : if( $obj->is_circular) { /Do Something/ }
 Function: Returns true if the molecule is circular
 Returns : Boolean value
 Args    : none
_attempt_to_load_SeqcodeprevnextTop
 Title   : _attempt_to_load_Seq
 Usage   :
 Function:
 Example :
 Returns :
 Args    :
Methods code
seqdescriptionprevnextTop
sub seq {
   my ($self) = @_;
   $self->throw_not_implemented();
}
subseqdescriptionprevnextTop
sub subseq {
   my ($self) = @_;
   $self->throw_not_implemented();
}
display_iddescriptionprevnextTop
sub display_id {
   my ($self) = @_;
   $self->throw_not_implemented();
}
accession_numberdescriptionprevnextTop
sub accession_number {
   my ($self,@args) = @_;
   $self->throw_not_implemented();
}
primary_iddescriptionprevnextTop
sub primary_id {
   my ($self,@args) = @_;
   $self->throw_not_implemented();
}
can_call_newdescriptionprevnextTop
sub can_call_new {
   my ($self,@args) = @_;

   # we default to 0 here
return 0;
}
alphabetdescriptionprevnextTop
sub alphabet {
    my ( $self ) = @_;
    $self->throw_not_implemented();
}
moltypedescriptionprevnextTop
sub moltype {
   my ($self,@args) = @_;

   $self->warn("moltype: pre v1.0 method. Calling alphabet() instead...");
   $self->alphabet(@args);
}
revcomdescriptionprevnextTop
sub revcom {
   my ($self) = @_;


   # check the type is good first.
my $t = $self->alphabet; if( $t eq 'protein' ) { $self->throw("Sequence is a protein. Cannot revcom"); } if( $t ne 'dna' && $t ne 'rna' ) { if( $self->can('warn') ) { $self->warn("Sequence is not dna or rna, but [$t]. ". "Attempting to revcom, but unsure if this is right"); } else { warn("[$self] Sequence is not dna or rna, but [$t]. ". "Attempting to revcom, but unsure if this is right"); } } # yank out the sequence string
my $str = $self->seq(); # if is RNA - map to DNA then map back
if( $t eq 'rna' ) { $str =~ tr/uU/tT/; } # revcom etc...
$str =~ tr/acgtrymkswhbvdnxACGTRYMKSWHBVDNX/tgcayrkmswdvbhnxTGCAYRKMSWDVBHNX/; my $revseq = CORE::reverse $str; if( $t eq 'rna' ) { $revseq =~ tr/tT/uU/; } my $seqclass; if($self->can_call_new()) { $seqclass = ref($self); } else { $seqclass = 'Bio::PrimarySeq'; $self->_attempt_to_load_Seq(); } my $out = $seqclass->new( '-seq' => $revseq, '-display_id' => $self->display_id, '-accession_number' => $self->accession_number, '-alphabet' => $self->alphabet, '-desc' => $self->desc(), '-verbose' => $self->verbose ); return $out;
}
truncdescriptionprevnextTop
sub trunc {
   my ($self,$start,$end) = @_;

   my $str;
   if( defined $start && ref($start) &&
       $start->isa('Bio::LocationI') ) {
       $str = $self->subseq($start); # start is a location actually
} elsif( !$end ) { $self->throw("trunc start,end -- there was no end for $start"); } elsif( $end < $start ) { my $msg = "start [$start] is greater than end [$end].\n ". "If you want to truncated and reverse complement,\n ". "you must call trunc followed by revcom. Sorry."; $self->throw($msg); } else { $str = $self->subseq($start,$end); } my $seqclass; if($self->can_call_new()) { $seqclass = ref($self); } else { $seqclass = 'Bio::PrimarySeq'; $self->_attempt_to_load_Seq(); } my $out = $seqclass->new( '-seq' => $str, '-display_id' => $self->display_id, '-accession_number' => $self->accession_number, '-alphabet' => $self->alphabet, '-desc' => $self->desc(), '-verbose' => $self->verbose ); return $out;
}
translatedescriptionprevnextTop
sub translate {
    my($self) = shift;
    my($stop, $unknown, $frame, $tableid, $fullCDS, $throw, $codonTable) = @_;
    my($i, $len, $output) = (0,0,'');
    my($codon)   = "";
    my $aa;

    ## User can pass in symbol for stop and unknown codons
unless(defined($stop) and $stop ne '') { $stop = "*"; } unless(defined($unknown) and $unknown ne '') { $unknown = "X"; } unless(defined($frame) and $frame ne '') { $frame = 0; } ## the codon table ID
unless(defined($tableid) and $tableid ne '') { $tableid = 1; } ##Error if monomer is "Amino"
$self->throw("Can't translate an amino acid sequence.") if ($self->alphabet eq 'protein'); ##Error if frame is not 0, 1 or 2
$self->throw("Valid values for frame are 0, 1, 2, not [$frame].") unless ($frame == 0 or $frame == 1 or $frame == 2); #warns if ID is invalid
if ($codonTable) { $self->throw("Need a Bio::Tools::CodonTable object, not". $codonTable) unless $codonTable->isa('Bio::Tools::CodonTable'); } else { $codonTable = Bio::Tools::CodonTable->new( -id => $tableid); } my ($seq) = $self->seq(); # deal with frame offset.
if( $frame ) { $seq = substr ($seq,$frame); } # Translate it
$output = $codonTable->translate($seq); # Use user-input stop/unknown
$output =~ s/\*/$stop/g; $output =~ s/X/$unknown/g; # only if we are expecting to translate a complete coding region
if ($fullCDS) { my $id = $self->display_id; #remove the stop character
if( substr($output,-1,1) eq $stop ) { chop $output; } else { $throw && $self->throw("Seq [$id]: Not using a valid terminator codon!"); $self->warn("Seq [$id]: Not using a valid terminator codon!"); } # test if there are terminator characters inside the protein sequence!
if ($output =~ /\*/) { $throw && $self->throw("Seq [$id]: Terminator codon inside CDS!"); $self->warn("Seq [$id]: Terminator codon inside CDS!"); } # if the initiator codon is not ATG, the amino acid needs to changed into M
if ( substr($output,0,1) ne 'M' ) { if ($codonTable->is_start_codon(substr($seq, 0, 3)) ) { $output = 'M'. substr($output,1); } elsif ($throw) { $self->throw("Seq [$id]: Not using a valid initiator codon!"); } else { $self->warn("Seq [$id]: Not using a valid initiator codon!"); } } } my $seqclass; if($self->can_call_new()) { $seqclass = ref($self); } else { $seqclass = 'Bio::PrimarySeq'; $self->_attempt_to_load_Seq(); } my $out = $seqclass->new( '-seq' => $output, '-display_id' => $self->display_id, '-accession_number' => $self->accession_number, # is there anything wrong with retaining the
# description?
'-desc' => $self->desc(), '-alphabet' => 'protein', '-verbose' => $self->verbose ); return $out;
}
iddescriptionprevnextTop
sub id {
   my ($self)= @_;

   return $self->display_id();
}
lengthdescriptionprevnextTop
sub length {
   my ($self)= @_;
   $self->throw_not_implemented();
}
descdescriptionprevnextTop
sub desc {
   shift->throw_not_implemented();
}
is_circulardescriptionprevnextTop
sub is_circular {
    shift->throw_not_implemented;
}
_attempt_to_load_SeqdescriptionprevnextTop
sub _attempt_to_load_Seq {
   my ($self) = @_;

   if( $main::{'Bio::PrimarySeq'} ) {
       return 1;
   } else {
       eval {
	   require Bio::PrimarySeq;
       };
       if( $@ ) {
	   my $text = "Bio::PrimarySeq could not be loaded for [$self]\n".
	       "This indicates that you are using Bio::PrimarySeqI ".
	       "without Bio::PrimarySeq loaded or without providing a ".
	       "complete implementation.\nThe most likely problem is that there ".
	       "has been a misconfiguration of the bioperl environment\n".
	       "Actual exception:\n\n";
	   $self->throw("$text$@\n");
	   return 0;
       }
       return 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://bio.perl.org/MailList.html           - About the mailing lists
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 email
or the web:
  bioperl-bugs@bio.perl.org
  http://bugzilla.bioperl.org/
AUTHOR - Ewan BirneyTop
Email birney@sanger.ac.uk
APPENDIXTop
The rest of the documentation details each of the object
methods. Internal methods are usually preceded with a _
Implementation Specific FunctionsTop
These functions are the ones that a specific implementation must
define.
Optional Implementation FunctionsTop
The following functions rely on the above functions. An
implementing class does not need to provide these functions, as they
will be provided by this class, but is free to override these
functions.
All of revcom(), trunc(), and translate() create new sequence
objects. They will call new() on the class of the sequence object
instance passed as argument, unless can_call_new() returns FALSE. In
the latter case a Bio::PrimarySeq object will be created. Implementors
which really want to control how objects are created (eg, for object
persistence over a database, or objects in a CORBA framework), they
are encouraged to override these methods
Private functionsTop
These are some private functions for the PrimarySeqI interface. You do not
need to implement these functions