1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
\name{write.tree}
\alias{write.tree}
\title{Write Tree File in Parenthetic Format}
\usage{
write.tree(phy, file = "", append = FALSE,
digits = 10, tree.names = FALSE)
}
\arguments{
\item{phy}{an object of class \code{"phylo"} or \code{"multiPhylo"}.}
\item{file}{a file name specified by either a variable of mode character,
or a double-quoted string; if \code{file = ""} (the default) then the
tree is written on the standard output connection (i.e. the console).}
\item{append}{a logical, if \code{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 (\code{FALSE} the default).}
\item{digits}{a numeric giving the number of digits used for printing
branch lengths.}
\item{tree.names}{either a logical or a vector of mode character. If
\code{TRUE} then any tree names will be written prior to the tree on
each line. If character, specifies the name of \code{"phylo"}
objects which can be written to the file.}
}
\description{
This function writes in a file a tree in parenthetic format using the
Newick (also known as New Hampshire) format.
}
\value{
a vector of mode character if \code{file = ""}, none (invisible
\code{NULL}) otherwise.
}
\details{
The node labels and the root edge length, if available, are written in
the file.
If \code{tree.names == TRUE} then a variant of the Newick format is
written for which the name of a tree precedes the Newick format tree
(parentheses are eventually deleted beforehand). The tree names are
taken from the \code{names} attribute if present (they are ignored if
\code{tree.names} is a character vector).
The tip labels (and the node labels if present) are checked before
being printed: the leading and trailing spaces, and the leading left
and trailing right parentheses are deleted; the other spaces are
replaced by underscores; the commas, colons, semicolons, and the other
parentheses are replaced with dashes.
}
\references{
Felsenstein, J. The Newick tree format.
\url{http://evolution.genetics.washington.edu/phylip/newicktree.html}
Olsen, G. Interpretation of the "Newick's 8:45" tree format standard.
\url{http://evolution.genetics.washington.edu/phylip/newick_doc.html}
}
\author{Emmanuel Paradis, Daniel Lawson
\email{dan.lawson@bristol.ac.uk}, and Klaus Schliep
\email{kschliep@snv.jussieu.fr}}
\seealso{
\code{\link{read.tree}}, \code{\link{read.nexus}},
\code{\link{write.nexus}}
}
\keyword{manip}
\keyword{IO}
|
