• NAME
• SYNOPSIS
• DESCRIPTION
• FEEDBACK
• AUTHORS
• VERSION
• METHODS
• new
• equals
• rename_otus

NAME

Bio::NEXUS::HistoryBlock - Represents a HISTORY block of a NEXUS file

SYNOPSIS

$block_object = new Bio::NEXUS::HistoryBlock('history', $block, $verbose);

DESCRIPTION

This is a class representing a history block in NEXUS file

FEEDBACK

All feedback (bugs, feature enhancements, etc.) are greatly appreciated.

AUTHORS

 Chengzhi Liang (liangc@umbi.umd.edu)
 Justin Reese
 Tom Hladish (tjhladish at yahoo)

VERSION

$Revision: 1.24 $

METHODS

new

 Title   : new
 Usage   : block_object = new Bio::NEXUS::HistoryBlock($block_type, $commands, $verbose);
 Function: Creates a new Bio::NEXUS::HistoryBlock object
 Returns : Bio::NEXUS::HistoryBlock object
 Args    : type (string), the commands/comments to parse (array ref), and a verbose flag (0 or 1; optional)
 Comments:

equals

 Name    : equals
 Usage   : $block->equals($another);
 Function: compare if two Block objects are equal
 Returns : boolean 
 Args    : a Block object

rename_otus

 Name    : rename_otus
 Usage   : $nexus->rename_otus(\%translation);
 Function: rename all OTUs 
 Returns : a new nexus object with new OTU names
 Args    : a ref to hash based on OTU name pairs