write.dendrogram: Write a dendrogram object to parenthetic text.

Description Usage Arguments References See Also Examples

View source: R/write.R

Description

This function exports a dendrogram object as a Newick/New Hampshire text string.

Usage

1
write.dendrogram(x, file = "", append = FALSE, edges = TRUE, ...)

Arguments

x

an object of class "dendrogram".

file

a character string naming a file or connection to write the output to. If no file path is specified or file = "" the result is printed to the console.

append

logical indicating whether the output should be appended to the file. If append = FALSE the contents of the file will be overwritten (the default setting).

edges

logical indicating whether edge weights should be included in the output string.

...

further arguments to be passed to format. Used to specify the numbering style of the edge weights (if edges = TRUE).

References

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

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

See Also

read.dendrogram to parse a "dendrogram" object from a text file. The write.tree function in the ape package performs a similar operation for "phylo" and "multiPhylo" objects.

Examples

1
2
3
  newick <- "(A:0.1,B:0.2,(C:0.3,D:0.4):0.5);"
  x <- read.dendrogram(text = newick)
  write.dendrogram(x, edges = TRUE)

Example output

[1] "(A:0.1,B:0.2,(C:0.3,D:0.4):0.5);"

phylogram documentation built on May 2, 2019, 3:46 p.m.