GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  BIO::PHYLO::UNPARSERS::NEWICK (3)

.ds Aq ’

NAME

Bio::Phylo::Unparsers::Newick - Serializer used by Bio::Phylo::IO, no serviceable parts inside

CONTENTS

DESCRIPTION

This module turns a tree object into a newick formatted (parenthetical) tree description. It is called by the Bio::Phylo::IO facade, don’t call it directly. You can pass the following additional arguments to the unparse call:



        # by default, names for tips are derived from $node->get_name, if
        # internal is specified, uses $node->get_internal_name, if taxon
        # uses $node->get_taxon->get_name, if taxon_internal uses
        # $node->get_taxon->get_internal_name, if $key, uses $node->get_generic($key)
        -tipnames => one of (internal|taxon|taxon_internal|$key)
       
        # for things like a translate table in nexus, or to specify truncated
        # 10-character names, you can pass a translate mapping as a hashref.
        # to generate the translated names, the strings obtained following the
        # -tipnames rules are used.
        -translate => { Homo_sapiens => 1, Pan_paniscus => 2 } 
       
        # array ref used to specify keys, which are embedded as key/value pairs (where
        # the value is obtained from $node->get_generic($key)) in comments,
        # formatted depending on -nhxstyle, which could be nhx (default), i.e.
        # [&&NHX:$key1=$value1:$key2=$value2] or mesquite, i.e.
        # [% $key1 = $value1, $key2 = $value2 ]
        -nhxkeys => [ $key1, $key2 ]   
       
        # if set, appends labels to internal nodes (names obtained from the same
        # source as specified by -tipnames)
        -nodelabels => 1
       
        # specifies a formatting style / dialect
        -nhxstyle => one of (mesquite|nhx)
       
        # specifies a branch length sprintf number formatting template, default is %f
        -blformat => %e



SEE ALSO

There is a mailing list at <https://groups.google.com/forum/#!forum/bio-phylo> for any user or developer questions and discussions.
Bio::Phylo::IO The newick unparser is called by the Bio::Phylo::IO object. Look there to learn how to unparse newick strings.
Bio::Phylo::Manual Also see the manual: Bio::Phylo::Manual and <http://rutgervos.blogspot.com>.

CITATION

If you use Bio::Phylo in published research, please cite it:

<B>Rutger A VosB>, <B>Jason CaravasB>, <B>Klaas HartmannB>, <B>Mark A JensenB> and <B>Chase MillerB>, 2011. Bio::Phylo - phyloinformatic analysis using Perl. BMC Bioinformatics <B>12B>:63. <http://dx.doi.org/10.1186/1471-2105-12-63>

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 BIO::PHYLO::UNPARSERS::NEWICK (3) 2014-02-08

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.