man/write.tree.Rd

   1 \name{write.tree}
   2 \alias{write.tree}
   3 \title{Write Tree File in Parenthetic Format}
   4 \usage{
   5 write.tree(phy, file = "", append = FALSE,
   6            digits = 10)
   7 }
   8 \arguments{
   9   \item{phy}{an object of class \code{"phylo"}.}
  10   \item{file}{a file name specified by either a variable of mode character,
  11     or a double-quoted string; if \code{file = ""} (the default) then the
  12     tree is written on the standard output connection (i.e. the console).}
  13   \item{append}{a logical, if \code{TRUE} the tree is appended to the file
  14     without erasing the data possibly existing in the file, otherwise
  15     the file (if it exists) is overwritten (\code{FALSE} the default).}
  16   \item{digits}{a numeric giving the number of digits used for printing
  17     branch lengths.}
  18 }
  19 \description{
  20   This function writes in a file a tree in parenthetic format using the
  21   Newick (also known as New Hampshire) format.
  22 }
  23 \value{
  24   a vector of mode character if \code{file = ""}, none (invisible
  25   `NULL') otherwise.
  26 }
  27 \details{
  28   The node labels and the root edge length, if available, are written in
  29   the file.
  30 }
  31 \references{
  32   Felsenstein, J. The Newick tree format.
  33   \url{http://evolution.genetics.washington.edu/phylip/newicktree.html}
  34
  35   Olsen, G. Interpretation of the "Newick's 8:45" tree format standard.
  36   \url{http://evolution.genetics.washington.edu/phylip/newick_doc.html}
  37 }
  38
  39 \author{Emmanuel Paradis \email{Emmanuel.Paradis@mpl.ird.fr}}
  40 \seealso{
  41   \code{\link{read.tree}}, \code{\link{read.nexus}},
  42   \code{\link{write.nexus}}
  43 }
  44 \keyword{manip}
  45 \keyword{IO}