/ 
Bio-Phylo-0.17_RC2
River stage two • 9 direct dependents • 18 total dependents
/ Bio::Phylo::Taxa::TaxonLinker

NAME

Bio::Phylo::Taxa::TaxonLinker - Superclass for objects that link to taxa objects.

SYNOPSIS

use Bio::Phylo::Forest::Node;
use Bio::Phylo::Taxa::Taxon;

my $node  = Bio::Phylo::Forest::Node->new;
my $taxon = Bio::Phylo::Taxa::Taxon->new;

if ( $node->isa('Bio::Phylo::Taxa::TaxonLinker') ) {
   $node->set_taxa( $taxon );
}

DESCRIPTION

This module is a superclass for objects that link to Bio::Phylo::Taxa::Taxon objects.

METHODS

MUTATORS

set_taxon()
Type    : Mutator
Title   : set_taxon
Usage   : $obj->set_taxon( $taxon );
Function: Links the invocant object
          to a taxon object.
Returns : Modified $obj
Args    : A Bio::Phylo::Taxa::Taxon object.
unset_taxon()
Type    : Mutator
Title   : unset_taxon
Usage   : $obj->unset_taxon();
Function: Unlinks the invocant object
          from any taxon object.
Returns : Modified $obj
Args    : NONE

ACCESSORS

get_taxon()
Type    : Accessor
Title   : get_taxon
Usage   : my $taxon = $obj->get_taxon;
Function: Retrieves the Bio::Phylo::Taxa::Taxon
          object linked to the invocant.
Returns : Bio::Phylo::Taxa::Taxon
Args    : NONE
Comments:

SEE ALSO

Bio::Phylo::Matrices::Datum

The datum object subclasses Bio::Phylo::Taxa::TaxonLinker.

Bio::Phylo::Forest::Node

The node object subclasses Bio::Phylo::Taxa::TaxonLinker.

Bio::Phylo::Manual

Also see the manual: Bio::Phylo::Manual.

FORUM

CPAN hosts a discussion forum for Bio::Phylo. If you have trouble using this module the discussion forum is a good place to start posting questions (NOT bug reports, see below): http://www.cpanforum.com/dist/Bio-Phylo

BUGS

Please report any bugs or feature requests to bug-bio-phylo@rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Bio-Phylo. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. Be sure to include the following in your request or comment, so that I know what version you're using:

$Id: TaxonLinker.pm 4175 2007-07-11 02:13:51Z rvosa $

AUTHOR

Rutger A. Vos,

email: rvosa@sfu.ca
web page: http://www.sfu.ca/~rvosa/

ACKNOWLEDGEMENTS

The author would like to thank Jason Stajich for many ideas borrowed from BioPerl http://www.bioperl.org, and CIPRES http://www.phylo.org and FAB* http://www.sfu.ca/~fabstar for comments and requests.

COPYRIGHT & LICENSE

Copyright 2005 Rutger A. Vos, All Rights Reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.