Bio::NEXUS::Block - Provides useful functions for blocks in NEXUS file (parent class).
This module is the super class of all NEXUS block classes. It is not used specifically from a program; in other words, you don't create a new Bio::NEXUS::Block object. Other modules, like AssumptionsBlock, simply inherit subroutines from this module.
Provides a few useful functions for general blocks (to be used by sub-classes).
All feedback (bugs, feature enhancements, etc.) are greatly appreciated.
Chengzhi Liang (liangc@umbi.umd.edu) Weigang Qiu (weigang@genectr.hunter.cuny.edu) Eugene Melamud (melamud@carb.nist.gov) Peter Yang (pyang@rice.edu) Thomas Hladish (tjhladish at yahoo)
$Revision: 1.49 $
Title : clone Usage : my $newblock = $block->clone(); Function: clone a block object (shallow) Returns : Block object Args : none
Title : get_type Usage : print $block->get_type(); Function: Returns a string containing the block type Returns : type (string) Args : none
Title : set_ntax Usage : print $block->set_ntax(); Function: Sets the value of Dimensions:ntax Returns : none Args : number of taxa (scalar)
Title : set_dimensions Usage : $block->set_dimensions($dimensions); Function: set a dimensions command Returns : none Args : hash content of dimensions command
Title : get_dimensions Usage : $block->get_dimensions($attribute); Function: get a dimensions command Returns : hash content of dimensions command, or the value for a particular attribute if specified Args : none, or a string
Title : set_command Usage : $block->set_command($command, $content); Function: Set a command Returns : none Args : comand name, and content (string)
Title : set_title Usage : $block->set_title($name); Function: Set the block name Returns : none Args : block name (string)
Title : get_title Usage : $block->get_title(); Function: Returns a string containing the block title Returns : name (string) Args : none
Title : set_link Usage : $block->set_link($link_hashref); Function: Set the block link commands Returns : none Args : block link (hash)
Title : add_link Usage : $block->add_link($linkname, $title); Function: add a link command Returns : none Args : $link, $title (of another block)
Title : get_link Usage : $block->get_link(); Function: Returns a hash containing the block links Returns : link (hash) Args : none
Title : set_taxlabels Usage : $block->set_taxlabels($labels); Function: Set the taxa names Returns : none Args : array of taxa names
Title : add_taxlabel Usage : $block->add_taxlabel($label); Function: add a taxon name Returns : none Args : a taxon name
Title : get_taxlabels Usage : $block->get_taxlabels(); Function: Returns an array of taxa labels Returns : taxa names Args : none
Title : set_otus Usage : $block->set_otus($otus); Function: sets the list of OTUs Returns : none Args : array of OTUs
Title : get_otus Usage : $block->get_otus(); Function: Returns array of otus Returns : all otus Args : none
Title : set_otuset Usage : $block->set_otuset($otuset); Function: Set the otus Returns : none Args : TaxUnitSet object
Title : get_otuset Usage : $block->get_otuset(); Function: get the OTUs Returns : TaxUnitSet object Args : none
Title : select_otus Usage : $block->select_otus($names); Function: select a subset of OTUs Returns : array of OTUs Args : OTU names
Title : rename_otus Usage : $block->rename_otus($names); Function: rename all OTUs Returns : none Args : hash of OTU names
Title : add_otu_clone Usage : ... Function: ... Returns : ... Args : ...
Title : set_comments Usage : $block->set_comments($comments); Function: Set the block comments Returns : none Args : block comments (array of strings)
Title : get_comments Usage : $block->get_comments(); Function: Returns block comments Returns : comments (array of strings) Args : none
Title : add_comment Usage : $block->add_comment($comment); Function: add a comment Returns : none Args : comment (string)
Name : equals Usage : $block->equals($another); Function: compare if two Block objects are equal Returns : boolean Args : a Block object'
To install Bio::NEXUS, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Bio::NEXUS
CPAN shell
perl -MCPAN -e shell install Bio::NEXUS
For more information on module installation, please visit the detailed CPAN module installation guide.