NAME

Bio::Phylo::Matrices::Datum - Character state sequence

SYNOPSIS

use Bio::Phylo::Factory;
my $fac = Bio::Phylo::Factory->new;

# instantiating a datum object...
my $datum = $fac->create_datum(
   -name   => 'Tooth comb size,
   -type   => 'STANDARD',
   -desc   => 'number of teeth in lower jaw comb',
   -pos    => 1,
   -weight => 2,
   -char   => [ 6 ],
);

# ...and linking it to a taxon object
my $taxon = $fac->create_taxon(
    -name => 'Lemur_catta'
);
$datum->set_taxon( $taxon );

# instantiating a matrix...
my $matrix = $fac->create_matrix;

# ...and insert datum in matrix
$matrix->insert($datum);

DESCRIPTION

The datum object models a single observation or a sequence of observations, which can be linked to a taxon object.

METHODS

CONSTRUCTOR

new()

Datum object constructor.

Type    : Constructor
Title   : new
Usage   : my $datum = Bio::Phylo::Matrices::Datum->new;
Function: Instantiates a Bio::Phylo::Matrices::Datum
          object.
Returns : A Bio::Phylo::Matrices::Datum object.
Args    : None required. Optional:
          -taxon  => $taxon,
          -weight => 0.234,
          -type   => DNA,           
          -pos    => 2,

new_from_bioperl()

Datum constructor from Bio::Seq argument.

Type    : Constructor
Title   : new_from_bioperl
Usage   : my $datum = 
          Bio::Phylo::Matrices::Datum->new_from_bioperl($seq);
Function: Instantiates a 
          Bio::Phylo::Matrices::Datum object.
Returns : A Bio::Phylo::Matrices::Datum object.
Args    : A Bio::Seq (or similar) object

MUTATORS

set_weight()

Sets invocant weight.

Type    : Mutator
Title   : set_weight
Usage   : $datum->set_weight($weight);
Function: Assigns a datum's weight.
Returns : Modified object.
Args    : The $weight argument must be a
          number in any of Perl's number
          formats.

set_char()

Sets character state(s)

Type    : Mutator
Title   : set_char
Usage   : $datum->set_char($char);
Function: Assigns a datum's character value.
Returns : Modified object.
Args    : The $char argument is checked against
          the allowed ranges for the various
          character types: IUPAC nucleotide (for
          types of DNA|RNA|NUCLEOTIDE), IUPAC
          single letter amino acid codes (for type
          PROTEIN), integers (STANDARD) or any of perl's
          decimal formats (CONTINUOUS). The $char can be:
              * a single character;
              * a string of characters;
              * an array reference of characters;
              * an array of characters;
Comments: Note that on assigning characters to a datum,
          previously set annotations are removed.

set_position()

Set invocant starting position.

Type    : Mutator
Title   : set_position
Usage   : $datum->set_position($pos);
Function: Assigns a datum's position.
Returns : Modified object.
Args    : $pos must be an integer.

set_annotation()

Sets single annotation.

Type    : Mutator
Title   : set_annotation
Usage   : $datum->set_annotation(
              -char       => 1,
              -annotation => { -codonpos => 1 }
          );
Function: Assigns an annotation to a
          character in the datum.
Returns : Modified object.
Args    : Required: -char       => $int
          Optional: -annotation => $hashref
Comments: Use this method to annotate
          a single character. To annotate
          multiple characters, use
          'set_annotations' (see below).

set_annotations()

Sets list of annotations.

Type    : Mutator
Title   : set_annotations
Usage   : $datum->set_annotations(
              { '-codonpos' => 1 },
              { '-codonpos' => 2 },
              { '-codonpos' => 3 },
          );
Function: Assign annotations to
          characters in the datum.
Returns : Modified object.
Args    : Hash references, where
          position in the argument
          list matches that of the
          specified characters in
          the character list. If no
          argument given, annotations
          are reset.
Comments: Use this method to annotate
          multiple characters. To
          annotate a single character,
          use 'set_annotation' (see
          above).

ACCESSORS

get_weight()

Gets invocant weight.

Type    : Accessor
Title   : get_weight
Usage   : my $weight = $datum->get_weight;
Function: Retrieves a datum's weight.
Returns : FLOAT
Args    : NONE

get_char()

Gets characters.

Type    : Accessor
Title   : get_char
Usage   : my $char = $datum->get_char;
Function: Retrieves a datum's character value.
Returns : In scalar context, returns a single
          character, or a string of characters
          (e.g. a DNA sequence, or a space
          delimited series of continuous characters).
          In list context, returns a list of characters
          (of zero or more characters).
Args    : NONE

get_position()

Gets invocant starting position.

Type    : Accessor
Title   : get_position
Usage   : my $pos = $datum->get_position;
Function: Retrieves a datum's position.
Returns : a SCALAR integer.
Args    : NONE

get_annotation()

Retrieves character annotation (hashref).

Type    : Accessor
Title   : get_annotation
Usage   : $datum->get_annotation(
              '-char' => 1,
              '-key'  => '-codonpos',
          );
Function: Retrieves an annotation to
          a character in the datum.
Returns : SCALAR or HASH
Args    : Optional: -char => $int
          Optional: -key => $key

get_annotations()

Retrieves character annotations (array ref).

Type    : Accessor
Title   : get_annotations
Usage   : my @anno = @{ $datum->get_annotation() };
Function: Retrieves annotations
Returns : ARRAY
Args    : NONE

get_length()

Gets invocant number of characters.

Type    : Accessor
Title   : get_length
Usage   : my $length = $datum->get_length;
Function: Retrieves a datum's length.
Returns : a SCALAR integer.
Args    : NONE

get_by_index()

Gets state at argument index.

Type    : Accessor
Title   : get_by_index
Usage   : my $val = $datum->get_by_index($i);
Function: Retrieves state at index $i.
Returns : a character state.
Args    : INT

get_index_of()

Returns the index of the first occurrence of the state observation in the datum or undef if the datum doesn't contain the argument

 Type    : Generic query
 Title   : get_index_of
 Usage   : my $i = $datum->get_index_of($state)
 Function: Returns the index of the first occurrence of the 
           state observation in the datum or undef if the datum 
		   doesn't contain the argument
 Returns : An index or undef
 Args    : A contained object

TESTS

can_contain()

Tests if invocant can contain argument.

Type    : Test
Title   : can_contain
Usage   : &do_something if $datum->can_contain( @args );
Function: Tests if $datum can contain @args
Returns : BOOLEAN
Args    : One or more arguments as can be provided to set_char

CALCULATIONS

calc_state_counts()

Calculates occurrences of states.

Type    : Calculation
Title   : calc_state_counts
Usage   : my %counts = %{ $datum->calc_state_counts };
Function: Calculates occurrences of states.
Returns : Hashref: keys are states, values are counts
Args    : Optional - one or more states to focus on

METHODS

reverse()

Reverses contents.

Type    : Method
Title   : reverse
Usage   : $datum->reverse;
Function: Reverses a datum's contained characters
Returns : Returns modified $datum
Args    : NONE

concat()

Appends argument to invocant.

Type    : Method
Title   : reverse
Usage   : $datum->concat($datum1);
Function: Appends $datum1 to $datum
Returns : Returns modified $datum
Args    : NONE

validate()

Validates invocant data contents.

Type    : Method
Title   : validate
Usage   : $datum->validate;
Function: Validates character data contained by $datum
Returns : True or throws Bio::Phylo::Util::Exceptions::InvalidData
Args    : NONE

clone()

Clones invocant.

Type    : Utility method
Title   : clone
Usage   : my $clone = $object->clone;
Function: Creates a copy of the invocant object.
Returns : A copy of the invocant.
Args    : None.
Comments: Cloning is currently experimental, use with caution.

to_xml()

Serializes datum to nexml format.

Type    : Format convertor
Title   : to_xml
Usage   : my $xml = $datum->to_xml;
Function: Converts datum object into a nexml element structure.
Returns : Nexml block (SCALAR).
Args    : -chars   => [] # optional, an array ref of character IDs
          -states  => {} # optional, a hash ref of state IDs
          -symbols => {} # optional, a hash ref of symbols

copy_atts()

Not implemented!

complement()

Not implemented!

slice()

Not implemented!

INHERITED METHODS

Bio::Phylo::Matrices::Datum inherits from one or more superclasses. This means that objects of class Bio::Phylo::Matrices::Datum also "do" the methods from the superclasses in addition to the ones implemented in this class. Below is the documentation for those additional methods, organized by superclass.

SUPERCLASS Bio::Phylo::Matrices::TypeSafeData

Bio::Phylo::Matrices::Datum inherits from superclass Bio::Phylo::Matrices::TypeSafeData. Below are the public methods (if any) from this superclass.

clone()

Clones invocant.

Type    : Utility method
Title   : clone
Usage   : my $clone = $object->clone;
Function: Creates a copy of the invocant object.
Returns : A copy of the invocant.
Args    : NONE

get_gap()

Get gap symbol.

Type    : Accessor
Title   : get_gap
Usage   : my $gap = $obj->get_gap;
Function: Returns the object's gap symbol
Returns : A string
Args    : None

get_lookup()

Get ambiguity lookup table.

Type    : Accessor
Title   : get_lookup
Usage   : my $lookup = $obj->get_lookup;
Function: Returns the object's lookup hash
Returns : A hash reference
Args    : None

get_missing()

Get missing data symbol.

Type    : Accessor
Title   : get_missing
Usage   : my $missing = $obj->get_missing;
Function: Returns the object's missing data symbol
Returns : A string
Args    : None

get_type()

Get data type.

Type    : Accessor
Title   : get_type
Usage   : my $type = $obj->get_type;
Function: Returns the object's datatype
Returns : A string
Args    : None

get_type_object()

Get data type object.

Type    : Accessor
Title   : get_type_object
Usage   : my $obj = $obj->get_type_object;
Function: Returns the object's linked datatype object
Returns : A subclass of Bio::Phylo::Matrices::Datatype
Args    : None

new()

TypeSafeData constructor.

Type    : Constructor
Title   : new
Usage   : No direct usage, is called by child class;
Function: Instantiates a Bio::Phylo::Matrices::TypeSafeData
Returns : a Bio::Phylo::Matrices::TypeSafeData child class
Args    : -type        => (data type - required)
          Optional:
          -missing     => (the symbol for missing data)
          -gap         => (the symbol for gaps)
          -lookup      => (a character state lookup hash)
          -type_object => (a datatype object)

set_gap()

Set gap data symbol.

Type    : Mutator
Title   : set_gap
Usage   : $obj->set_gap('-');
Function: Sets the symbol for gaps
Returns : Modified object.
Args    : Argument must be a single
          character, default is '-'

set_lookup()

Set ambiguity lookup table.

Type    : Mutator
Title   : set_lookup
Usage   : $obj->set_gap($hashref);
Function: Sets the symbol for gaps
Returns : Modified object.
Args    : Argument must be a hash
          reference that maps allowed
          single character symbols
          (including ambiguity symbols)
          onto the equivalent set of
          non-ambiguous symbols

set_missing()

Set missing data symbol.

Type    : Mutator
Title   : set_missing
Usage   : $obj->set_missing('?');
Function: Sets the symbol for missing data
Returns : Modified object.
Args    : Argument must be a single
          character, default is '?'

set_type()

Set data type.

Type    : Mutator
Title   : set_type
Usage   : $obj->set_type($type);
Function: Sets the object's datatype.
Returns : Modified object.
Args    : Argument must be a string, one of
          continuous, custom, dna, mixed,
          protein, restriction, rna, standard

set_type_object()

Set data type object.

Type    : Mutator
Title   : set_type_object
Usage   : $obj->set_gap($obj);
Function: Sets the datatype object
Returns : Modified object.
Args    : Argument must be a subclass
          of Bio::Phylo::Matrices::Datatype

validate()

Validates the object's contents

Type    : Interface method
Title   : validate
Usage   : $obj->validate
Function: Validates the object's contents
Returns : True or throws Bio::Phylo::Util::Exceptions::InvalidData
Args    : None
Comments: This is an interface method, i.e. this class doesn't
          implement the method, child classes have to

SUPERCLASS Bio::Phylo::Listable

Bio::Phylo::Matrices::Datum inherits from superclass Bio::Phylo::Listable. Below are the public methods (if any) from this superclass.

add_set()

Type    : Mutator
Title   : add_set
Usage   : $obj->add_set($set)
Function: Associates a Bio::Phylo::Set object with the invocant
Returns : Invocant
Args    : A Bio::Phylo::Set object

add_to_set()

Type    : Mutator
Title   : add_to_set
Usage   : $listable->add_to_set($obj,$set);
Function: Adds first argument to the second argument
Returns : Invocant
Args    : $obj - an object to add to $set
          $set - the Bio::Phylo::Set object to add to
Notes   : this method assumes that $obj is already 
          part of the invocant. If that assumption is
          violated a warning message is printed.

can_contain()

Tests if argument can be inserted in invocant.

Type    : Test
Title   : can_contain
Usage   : &do_something if $listable->can_contain( $obj );
Function: Tests if $obj can be inserted in $listable
Returns : BOOL
Args    : An $obj to test

clear()

Empties container object.

Type    : Object method
Title   : clear
Usage   : $obj->clear();
Function: Clears the container.
Returns : A Bio::Phylo::Listable object.
Args    : Note.
Note    :

clone()

Clones invocant.

Type    : Utility method
Title   : clone
Usage   : my $clone = $object->clone;
Function: Creates a copy of the invocant object.
Returns : A copy of the invocant.
Args    : None.
Comments: Cloning is currently experimental, use with caution.

contains()

Tests whether the invocant object contains the argument object.

Type    : Test
Title   : contains
Usage   : if ( $obj->contains( $other_obj ) ) {
              # do something
          }
Function: Tests whether the invocant object 
          contains the argument object
Returns : BOOLEAN
Args    : A Bio::Phylo::* object

cross_reference()

The cross_reference method links node and datum objects to the taxa they apply to. After crossreferencing a matrix with a taxa object, every datum object has a reference to a taxon object stored in its $datum->get_taxon field, and every taxon object has a list of references to datum objects stored in its $taxon->get_data field.

Type    : Generic method
Title   : cross_reference
Usage   : $obj->cross_reference($taxa);
Function: Crossreferences the entities 
          in the invocant with names 
          in $taxa
Returns : string
Args    : A Bio::Phylo::Taxa object
Comments:

current()

Returns the current focal element of the listable object.

Type    : Iterator
Title   : current
Usage   : my $current_obj = $obj->current;
Function: Retrieves the current focal 
          entity in the invocant.
Returns : A Bio::Phylo::* object
Args    : none.

current_index()

Returns the current internal index of the invocant.

Type    : Generic query
Title   : current_index
Usage   : my $last_index = $obj->current_index;
Function: Returns the current internal 
          index of the invocant.
Returns : An integer
Args    : none.

delete()

Deletes argument from invocant object.

Type    : Object method
Title   : delete
Usage   : $obj->delete($other_obj);
Function: Deletes an object from its container.
Returns : A Bio::Phylo::Listable object.
Args    : A Bio::Phylo::* object.
Note    : Be careful with this method: deleting 
          a node from a tree like this will 
          result in undefined references in its 
          neighbouring nodes. Its children will 
          have their parent reference become 
          undef (instead of pointing to their 
          grandparent, as collapsing a node would 
          do). The same is true for taxon objects 
          that reference datum objects: if the 
          datum object is deleted from a matrix 
          (say), the taxon will now hold undefined 
          references.

first()

Jumps to the first element contained by the listable object.

Type    : Iterator
Title   : first
Usage   : my $first_obj = $obj->first;
Function: Retrieves the first 
          entity in the invocant.
Returns : A Bio::Phylo::* object
Args    : none.

get_by_index()

Gets element defined by argument index from invocant container.

Type    : Query
Title   : get_by_index
Usage   : my $contained_obj = $obj->get_by_index($i);
Function: Retrieves the i'th entity 
          from a listable object.
Returns : An entity stored by a listable 
          object (or array ref for slices).
Args    : An index or range. This works 
          the way you dereference any perl
          array including through slices, 
          i.e. $obj->get_by_index(0 .. 10)>
          $obj->get_by_index(0, -1) 
          and so on.
Comments: Throws if out-of-bounds

get_by_name()

Gets first element that has argument name

Type    : Visitor predicate
Title   : get_by_name
Usage   : my $found = $obj->get_by_name('foo');
Function: Retrieves the first contained object
          in the current Bio::Phylo::Listable 
          object whose name is 'foo'
Returns : A Bio::Phylo::* object.
Args    : A name (string)

get_by_regular_expression()

Gets elements that match regular expression from invocant container.

Type    : Visitor predicate
Title   : get_by_regular_expression
Usage   : my @objects = @{ 
              $obj->get_by_regular_expression(
                   -value => $method,
                   -match => $re
           ) };
Function: Retrieves the data in the 
          current Bio::Phylo::Listable 
          object whose $method output 
          matches $re
Returns : A list of Bio::Phylo::* objects.
Args    : -value => any of the string 
                    datum props (e.g. 'get_type')
          -match => a compiled regular 
                    expression (e.g. qr/^[D|R]NA$/)

get_by_value()

Gets elements that meet numerical rule from invocant container.

Type    : Visitor predicate
Title   : get_by_value
Usage   : my @objects = @{ $obj->get_by_value(
             -value => $method,
             -ge    => $number
          ) };
Function: Iterates through all objects 
          contained by $obj and returns 
          those for which the output of 
          $method (e.g. get_tree_length) 
          is less than (-lt), less than 
          or equal to (-le), equal to 
          (-eq), greater than or equal to 
          (-ge), or greater than (-gt) $number.
Returns : A reference to an array of objects
Args    : -value => any of the numerical 
                    obj data (e.g. tree length)
          -lt    => less than
          -le    => less than or equals
          -eq    => equals
          -ge    => greater than or equals
          -gt    => greater than

get_entities()

Returns a reference to an array of objects contained by the listable object.

Type    : Generic query
Title   : get_entities
Usage   : my @entities = @{ $obj->get_entities };
Function: Retrieves all entities in the invocant.
Returns : A reference to a list of Bio::Phylo::* 
          objects.
Args    : none.

get_index_of()

Returns the index of the argument in the list, or undef if the list doesn't contain the argument

Type    : Generic query
Title   : get_index_of
Usage   : my $i = $listable->get_index_of($obj)
Function: Returns the index of the argument in the list,
          or undef if the list doesn't contain the argument
Returns : An index or undef
Args    : A contained object

get_logger()

Gets a logger object.

Type    : Accessor
Title   : get_logger
Usage   : my $logger = $obj->get_logger;
Function: Returns a Bio::Phylo::Util::Logger object
Returns : Bio::Phylo::Util::Logger
Args    : None

get_sets()

Type    : Accessor
Title   : get_sets
Usage   : my @sets = @{ $obj->get_sets() };
Function: Retrieves all associated Bio::Phylo::Set objects
Returns : Invocant
Args    : None

insert()

Pushes an object into its container.

Type    : Object method
Title   : insert
Usage   : $obj->insert($other_obj);
Function: Pushes an object into its container.
Returns : A Bio::Phylo::Listable object.
Args    : A Bio::Phylo::* object.

insert_at_index()

Inserts argument object in invocant container at argument index.

Type    : Object method
Title   : insert_at_index
Usage   : $obj->insert_at_index($other_obj, $i);
Function: Inserts $other_obj at index $i in container $obj
Returns : A Bio::Phylo::Listable object.
Args    : A Bio::Phylo::* object.

is_in_set()

Type    : Test
Title   : is_in_set
Usage   : @do_something if $listable->is_in_set($obj,$set);
Function: Returns whether or not the first argument is listed in the second argument
Returns : Boolean
Args    : $obj - an object that may, or may not be in $set
          $set - the Bio::Phylo::Set object to query
Notes   : This method makes two assumptions:
          i) the $set object is associated with the invocant,
             i.e. add_set($set) has been called previously
          ii) the $obj object is part of the invocant
          If either assumption is violated a warning message
          is printed.

last()

Jumps to the last element contained by the listable object.

Type    : Iterator
Title   : last
Usage   : my $last_obj = $obj->last;
Function: Retrieves the last 
          entity in the invocant.
Returns : A Bio::Phylo::* object
Args    : none.

last_index()

Returns the highest valid index of the invocant.

Type    : Generic query
Title   : last_index
Usage   : my $last_index = $obj->last_index;
Function: Returns the highest valid 
          index of the invocant.
Returns : An integer
Args    : none.

next()

Returns the next focal element of the listable object.

Type    : Iterator
Title   : next
Usage   : my $next_obj = $obj->next;
Function: Retrieves the next focal 
          entity in the invocant.
Returns : A Bio::Phylo::* object
Args    : none.

notify_listeners()

Notifies listeners of changed contents.

Type    : Utility method
Title   : notify_listeners
Usage   : $object->notify_listeners;
Function: Notifies listeners of changed contents.
Returns : Invocant.
Args    : NONE.
Comments:

previous()

Returns the previous element of the listable object.

Type    : Iterator
Title   : previous
Usage   : my $previous_obj = $obj->previous;
Function: Retrieves the previous 
          focal entity in the invocant.
Returns : A Bio::Phylo::* object
Args    : none.

remove_from_set()

Type    : Mutator
Title   : remove_from_set
Usage   : $listable->remove_from_set($obj,$set);
Function: Removes first argument from the second argument
Returns : Invocant
Args    : $obj - an object to remove from $set
          $set - the Bio::Phylo::Set object to remove from
Notes   : this method assumes that $obj is already 
          part of the invocant. If that assumption is
          violated a warning message is printed.

remove_set()

Type    : Mutator
Title   : remove_set
Usage   : $obj->remove_set($set)
Function: Removes association between a Bio::Phylo::Set object and the invocant
Returns : Invocant
Args    : A Bio::Phylo::Set object

set_listener()

Attaches a listener (code ref) which is executed when contents change.

Type    : Utility method
Title   : set_listener
Usage   : $object->set_listener( sub { my $object = shift; } );
Function: Attaches a listener (code ref) which is executed when contents change.
Returns : Invocant.
Args    : A code reference.
Comments: When executed, the code reference will receive $object
          (the invocant) as its first argument.

visit()

Iterates over objects contained by invocant, executes argument code reference on each.

Type    : Visitor predicate
Title   : visit
Usage   : $obj->visit( 
              sub{ print $_[0]->get_name, "\n" } 
          );
Function: Implements visitor pattern 
          using code reference.
Returns : The invocant, possibly modified.
Args    : a CODE reference.

SUPERCLASS Bio::Phylo::Util::XMLWritable

Bio::Phylo::Matrices::Datum inherits from superclass Bio::Phylo::Util::XMLWritable. Below are the public methods (if any) from this superclass.

add_dictionary()

Type    : Mutator
Title   : add_dictionary
Usage   : $obj->add_dictionary($dict);
Function: Adds a dictionary attachment to the object
Returns : $self
Args    : Bio::Phylo::Dictionary

get_attributes()

Retrieves attributes for the element.

Type    : Accessor
Title   : get_attributes
Usage   : my %attrs = %{ $obj->get_attributes };
Function: Gets the xml attributes for the object;
Returns : A hash reference
Args    : None.
Comments: throws ObjectMismatch if no linked taxa object 
          can be found

get_dictionaries()

Retrieves the dictionaries for the element.

Type    : Accessor
Title   : get_dictionaries
Usage   : my @dicts = @{ $obj->get_dictionaries };
Function: Retrieves the dictionaries for the element.
Returns : An array ref of Bio::Phylo::Dictionary objects
Args    : None.

get_namespaces()

Type    : Accessor
Title   : get_namespaces
Usage   : my %ns = %{ $obj->get_namespaces };
Function: Retrieves the known namespaces
Returns : A hash of prefix/namespace key/value pairs, or
          a single namespace if a single, optional
          prefix was provided as argument
Args    : Optional - a namespace prefix

get_tag()

Retrieves tag name for the element.

Type    : Accessor
Title   : get_tag
Usage   : my $tag = $obj->get_tag;
Function: Gets the xml tag name for the object;
Returns : A tag name
Args    : None.

get_xml_id()

Retrieves xml id for the element.

Type    : Accessor
Title   : get_xml_id
Usage   : my $id = $obj->get_xml_id;
Function: Gets the xml id for the object;
Returns : An xml id
Args    : None.

get_xml_tag()

Retrieves tag string

Type    : Accessor
Title   : get_xml_tag
Usage   : my $str = $obj->get_xml_tag;
Function: Gets the xml tag for the object;
Returns : A tag, i.e. pointy brackets
Args    : Optional: a true value, to close an empty tag

is_identifiable()

By default, all XMLWritable objects are identifiable when serialized, i.e. they have a unique id attribute. However, in some cases a serialized object may not have an id attribute (governed by the nexml schema). This method indicates whether that is the case.

Type    : Test
Title   : is_identifiable
Usage   : if ( $obj->is_identifiable ) { ... }
Function: Indicates whether IDs are generated
Returns : BOOLEAN
Args    : NONE

remove_dictionary()

Type    : Mutator
Title   : remove_dictionary
Usage   : $obj->remove_dictionary($dict);
Function: Removes a dictionary attachment from the object
Returns : $self
Args    : Bio::Phylo::Dictionary

set_attributes()

Assigns attributes for the element.

Type    : Mutator
Title   : set_attributes
Usage   : $obj->set_attributes( 'foo' => 'bar' )
Function: Sets the xml attributes for the object;
Returns : $self
Args    : key/value pairs or a hash ref

set_identifiable()

Type    : Mutator
Title   : set_identifiable
Usage   : $obj->set_tag(0);
Function: Enables/disables id generation
Returns : $self
Args    : BOOLEAN

set_namespaces()

Type    : Mutator
Title   : set_namespaces
Usage   : $obj->set_namespaces( 'dwc' => 'http://www.namespaceTBD.org/darwin2' );
Function: Adds one or more prefix/namespace pairs
Returns : $self
Args    : One or more prefix/namespace pairs, as even-sized list, 
          or as a hash reference, i.e.:
          $obj->set_namespaces( 'dwc' => 'http://www.namespaceTBD.org/darwin2' );
          or
          $obj->set_namespaces( { 'dwc' => 'http://www.namespaceTBD.org/darwin2' } );
Notes   : This is a global for the XMLWritable class, so that in a recursive
		   to_xml call the outermost element contains the namespace definitions.
		   This method can also be called as a static class method, i.e.
		   Bio::Phylo::Util::XMLWritable->set_namespaces(
		   'dwc' => 'http://www.namespaceTBD.org/darwin2');

set_tag()

This method is usually only used internally, to define or alter the name of the tag into which the object is serialized. For example, for a Bio::Phylo::Forest::Node object, this method would be called with the 'node' argument, so that the object is serialized into an xml element structure called <node/>

Type    : Mutator
Title   : set_tag
Usage   : $obj->set_tag('node');
Function: Sets the tag name
Returns : $self
Args    : A tag name (must be a valid xml element name)

set_xml_id()

This method is usually only used internally, to store the xml id of an object as it is parsed out of a nexml file - this is for the purpose of round-tripping nexml info sets.

Type    : Mutator
Title   : set_xml_id
Usage   : $obj->set_xml_id('node345');
Function: Sets the xml id
Returns : $self
Args    : An xml id (must be a valid xml NCName)

to_xml()

Serializes invocant to XML.

Type    : XML serializer
Title   : to_xml
Usage   : my $xml = $obj->to_xml;
Function: Serializes $obj to xml
Returns : An xml string
Args    : None

SUPERCLASS Bio::Phylo

Bio::Phylo::Matrices::Datum inherits from superclass Bio::Phylo. Below are the public methods (if any) from this superclass.

clone()

Clones invocant.

Type    : Utility method
Title   : clone
Usage   : my $clone = $object->clone;
Function: Creates a copy of the invocant object.
Returns : A copy of the invocant.
Args    : None.
Comments: Cloning is currently experimental, use with caution.

get()

Attempts to execute argument string as method on invocant.

Type    : Accessor
Title   : get
Usage   : my $treename = $tree->get('get_name');
Function: Alternative syntax for safely accessing
          any of the object data; useful for
          interpolating runtime $vars.
Returns : (context dependent)
Args    : a SCALAR variable, e.g. $var = 'get_name';

get_desc()

Gets invocant description.

Type    : Accessor
Title   : get_desc
Usage   : my $desc = $obj->get_desc;
Function: Returns the object's description (if any).
Returns : A string
Args    : None

get_generic()

Gets generic hashref or hash value(s).

Type    : Accessor
Title   : get_generic
Usage   : my $value = $obj->get_generic($key);
          or
          my %hash = %{ $obj->get_generic() };
Function: Returns the object's generic data. If an
          argument is used, it is considered a key
          for which the associated value is returned.
          Without arguments, a reference to the whole
          hash is returned.
Returns : A string or hash reference.
Args    : None

get_id()

Gets invocant's UID.

Type    : Accessor
Title   : get_id
Usage   : my $id = $obj->get_id;
Function: Returns the object's unique ID
Returns : INT
Args    : None

get_internal_name()

Gets invocant's 'fallback' name (possibly autogenerated).

Type    : Accessor
Title   : get_internal_name
Usage   : my $name = $obj->get_internal_name;
Function: Returns the object's name (if none was set, the name
          is a combination of the $obj's class and its UID).
Returns : A string
Args    : None

get_logger()

Gets a logger object.

Type    : Accessor
Title   : get_logger
Usage   : my $logger = $obj->get_logger;
Function: Returns a Bio::Phylo::Util::Logger object
Returns : Bio::Phylo::Util::Logger
Args    : None

get_name()

Gets invocant's name.

Type    : Accessor
Title   : get_name
Usage   : my $name = $obj->get_name;
Function: Returns the object's name.
Returns : A string
Args    : None

get_obj_by_id()

Attempts to fetch an in-memory object by its UID

Type    : Accessor
Title   : get_obj_by_id
Usage   : my $obj = Bio::Phylo->get_obj_by_id($uid);
Function: Fetches an object from the IDPool cache
Returns : A Bio::Phylo object 
Args    : A unique id

get_score()

Gets invocant's score.

Type    : Accessor
Title   : get_score
Usage   : my $score = $obj->get_score;
Function: Returns the object's numerical score (if any).
Returns : A number
Args    : None

new()

The Bio::Phylo root constructor, is rarely used directly. Rather, many other objects in Bio::Phylo internally go up the inheritance tree to this constructor. The arguments shown here can therefore also be passed to any of the child classes' constructors, which will pass them on up the inheritance tree. Generally, constructors in Bio::Phylo subclasses can process as arguments all methods that have set_* in their names. The arguments are named for the methods, but "set_" has been replaced with a dash "-", e.g. the method "set_name" becomes the argument "-name" in the constructor.

Type    : Constructor
Title   : new
Usage   : my $phylo = Bio::Phylo->new;
Function: Instantiates Bio::Phylo object
Returns : a Bio::Phylo object 
Args    : Optional, any number of setters. For example,
		   Bio::Phylo->new( -name => $name )
		   will call set_name( $name ) internally

set_desc()

Sets invocant description.

Type    : Mutator
Title   : set_desc
Usage   : $obj->set_desc($desc);
Function: Assigns an object's description.
Returns : Modified object.
Args    : Argument must be a string.

set_generic()

Sets generic key/value pair(s).

Type    : Mutator
Title   : set_generic
Usage   : $obj->set_generic( %generic );
Function: Assigns generic key/value pairs to the invocant.
Returns : Modified object.
Args    : Valid arguments constitute:

          * key/value pairs, for example:
            $obj->set_generic( '-lnl' => 0.87565 );

          * or a hash ref, for example:
            $obj->set_generic( { '-lnl' => 0.87565 } );

          * or nothing, to reset the stored hash, e.g.
               $obj->set_generic( );

set_name()

Sets invocant name.

Type    : Mutator
Title   : set_name
Usage   : $obj->set_name($name);
Function: Assigns an object's name.
Returns : Modified object.
Args    : Argument must be a string, will be single 
          quoted if it contains [;|,|:\(|\)] 
          or spaces. Preceding and trailing spaces
          will be removed.

set_score()

Sets invocant score.

Type    : Mutator
Title   : set_score
Usage   : $obj->set_score($score);
Function: Assigns an object's numerical score.
Returns : Modified object.
Args    : Argument must be any of
          perl's number formats, or undefined
          to reset score.

to_json()

Serializes object to JSON string

Type    : Serializer
Title   : to_json()
Usage   : print $obj->to_json();
Function: Serializes object to JSON string
Returns : String 
Args    : None
Comments:

to_string()

Serializes object to general purpose string

Type    : Serializer
Title   : to_string()
Usage   : print $obj->to_string();
Function: Serializes object to general purpose string
Returns : String 
Args    : None
Comments: This is YAML

SUPERCLASS Bio::Phylo::Taxa::TaxonLinker

Bio::Phylo::Matrices::Datum inherits from superclass Bio::Phylo::Taxa::TaxonLinker. Below are the public methods (if any) from this superclass.

get_taxon()

Retrieves the Bio::Phylo::Taxa::Taxon object linked to the invocant.

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:

set_taxon()

Links the invocant object to a taxon object.

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()

Unlinks the invocant object from any taxon object.

Type    : Mutator
Title   : unset_taxon
Usage   : $obj->unset_taxon();
Function: Unlinks the invocant object
          from any taxon object.
Returns : Modified $obj
Args    : NONE

REVISION

$Id: Datum.pm 844 2009-03-05 00:07:26Z rvos $

To install Bio::Phylo, copy and paste the appropriate command in to your terminal.

cpanm

cpanm Bio::Phylo

CPAN shell

perl -MCPAN -e shell
install Bio::Phylo

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

SYNOPSIS

DESCRIPTION

METHODS

CONSTRUCTOR

MUTATORS

ACCESSORS

TESTS

CALCULATIONS

METHODS

INHERITED METHODS

SUPERCLASS Bio::Phylo::Matrices::TypeSafeData

SUPERCLASS Bio::Phylo::Listable

SUPERCLASS Bio::Phylo::Util::XMLWritable

SUPERCLASS Bio::Phylo

SUPERCLASS Bio::Phylo::Taxa::TaxonLinker

SEE ALSO

REVISION

Module Install Instructions