NAME

Bio::Tree::AlleleNode - DESCRIPTION of Object

SYNOPSIS

Give standard usage here

DESCRIPTION

Describe the object here

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 the Bioperl mailing list. Your participation is much appreciated.

bioperl-l@bioperl.org              - General discussion
http://bioperl.org/MailList.shtml  - About the mailing lists

Reporting Bugs

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 email or the web:

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

AUTHOR - Jason Stajich

Email jason@bioperl.org

Describe contact details here

CONTRIBUTORS

Additional contributors names and emails here

APPENDIX

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

new

Title   : new
Usage   : my $obj = new Bio::Tree::AlleleNode();
Function: Builds a new Bio::Tree::AlleleNode object 
Returns : Bio::Tree::AlleleNode
Args    :

add_alleles

Title   : add_alleles
Usage   : $node->add_alleles($mkr,@alleles);
Function: Adds allele(s) for $mkr, @alleles can be a single or 
          multiple alleles. If the same marker is added more than one, the 
          previous value will be overwritten with a warning.
Returns : none
Args    : $marker => marker name
          @alleles => alleles for the marker

get_alleles

Title   : get_alleles
Usage   : my @alleles = $node->get_alleles($marker);
Function: Return the alleles for a marker $marker
Returns : Array of Alleles for a marker or empty array
Args    : $marker name

get_marker_names

Title   : get_marker_names
Usage   : my @names =$node->get_marker_names();
Function: Return the names of the markers that have been added to this node
Returns : List of Marker Names
Args    : none

purge_markers

Title   : purge_markers
Usage   : $node->purge_markers;
Function: Reset the markers and alleles
Returns : none
Args    : none