writePhySim.tree {PhySim}R Documentation

Write Tree File in Parenthetic Format

Description

This function writes in a file a tree in parenthetic format using the Newick (also known as New Hampshire) format.

Usage

writePhySim.tree(phy, file = "", append = FALSE, format = "Newick",
           multi.line = TRUE, digits = 10)

Arguments

phy an object of class "phylo" compatible with PhySim or versions of APE predating 1.8-4.
file a file name specified by either a variable of mode character, or a double-quoted string; if file = "" (the default) then the tree is written on the standard output connection (i.e. the console).
append a logical, if TRUE the tree is appended to the file without erasing the data possibly existing in the file, otherwise the file (if it exists) is overwritten (FALSE the default).
format a character giving the format of the tree file; by default "Newick". Currently only "Newick" is available.
multi.line a logical, if TRUE (the default) line breaks are introduced in the tree in parenthetic form.
digits a numeric giving the number of digits used for printing branch lengths.

Details

The node labels and the root edge length, if available, are written in the file.

Value

a vector of mode character if file = "", none (invisible ‘NULL’) otherwise.

Note

phylogenetic tree information in PhySim is stored in objects of class phylo compatible with old versions of APE (<=1.8-4) but in a format no longer usable by that program. In order to use phylogenetic trees generated by PhySim in APE first write the tree using function writePhySim.tree and then read the tree into a format compatible with APE using the APE function read.tree.

wirtePhySim.tree and this help file are derived from write.tree and its helpfile obtained from old versions of the package APE (<=1.8-4) by Emmanuel Paradis.

Author(s)

Emmanuel Paradis

References

Felsenstein, J. The Newick tree format. http://evolution.genetics.washington.edu/phylip/newicktree.html

Olsen, G. Interpretation of the "Newick's 8:45" tree format standard. http://evolution.genetics.washington.edu/phylip/newick_doc.html

See Also

readPhySim.tree, to read a phylogenetic tree from a file


[Package PhySim version 1.0 Index]