/ 
bioperl-1.2.3
/ Bio::SeqFeature::Primer

NAME

Bio::SeqFeature::Primer - Primer Generic SeqFeature

SYNOPSIS

A synopsis does not yet exist for this module.

DESCRIPTION

A description does not yet exist for this module.

FEEDBACK

Mailing Lists

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 Bugs

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 - Chad Matsalla

Chad Matsalla <bioinformatics1@dieselwurks.com>

APPENDIX

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

new()

Title   : new()
Usage   :
Function:
Example :
Returns :
Args    : 
Devel notes: I think that I want to accept a hash

seq()

Title   : seq()
Usage   : $seq = $primer->seq();
Function: Return the _entire_ sequence associated with this Primer. 
Returns : A Bio::Seq object
Args    : None.
Develper Note: Do you want to be able to set the sequence associated with this
    SeqFeature?

all_tags()

Title   : all_tags()
Usage   : @tags = $primer->all_tags();
Function: Return a list of tag names for this Primer.
Returns : An array of strings representing the names of tags in this Primer
Args    : None.
Notes   : When the Bio::SeqFeature::Primer object is created, the user can
    pass in an arbitrary hash containing key->value pairs. This is allowed
    because I didn't want to assume that the user was trying to model a
    primer3 construct.

primary_tag()

Title   : primary_tag()
Usage   : $tag = $feature->primary_tag();
Function: Returns the string "Primer"
Returns : A string.
Args    : None.

source_tag()

Title   : source_tag()
Usage   : $tag = $feature->source_tag();
Function: Returns the source of this tag.
Returns : A string.
Args    : If an argument is provided, the source of this SeqFeature
    is set to that argument.

has_tag()

Title   : has_tag()
Usage   : $true_or_false = $feature->has_tag('MELTING_TEMPERATURE');
Function: Does this SeqFeature have this tag?
Returns : TRUE or FALSE
Args    : A string.

each_tag_value()

Title   : each_tag_value()
Usage   : $tag = $feature->each_tag_value('MELTING_TEMPERATURE');
Function: Returns the value of this tag.
Returns : Unknown. Whatever the value of the given tag was.
Args    : None.

location()

Title   : location()
Usage   : $tag = $feature->location();
Function: returns a location object suitable for identifying location of
    feature on sequence or parent feature  
Returns : a bio::locationi object.
Args    : none.
Developer Notes: Chad has no idea how to implement this at this time.

start()

Title   : start()
Usage   : $start_position = $feature->start($new_position);
Function: Return the start position of this Primer.
Returns : The start position of this Primer.
Args    : If an argument is provided, the start position of this
    Primer is set to that position.

end()

Title   : end()
Usage   : $end_position = $feature->end($new_position);
Function: Return the end position of this Primer.
Returns : The end position of this Primer.
Args    : If an argument is provided, the end position of this
    Primer is set to that position.

strand()

Title   : strand()
Usage   : 
Function: 
Returns : 
Args    : 
Developer Notes: Chad has no idea how to implement this at this time.

display_id()

Title   : display_id()
Usage   : $id = $feature->display_id($new_id)
Function: Returns the display ID for this Primer feature
Returns : A scalar.
Args    : If an argument is provided, the display_id of this Primer is
    set to that value.