man/write.nexus.Rd

   1 \name{write.nexus}
   2 \alias{write.nexus}
   3 \title{Write Tree File in Nexus Format}
   4 \usage{
   5 write.nexus(..., file = "", translate = TRUE, original.data = TRUE)
   6 }
   7 \arguments{
   8   \item{\dots}{either (i) a single object of class \code{"phylo"}, (ii) a
   9     series of such objects separated by commas, or (iii) a list
  10     containing such objects.}
  11   \item{file}{a file name specified by either a variable of mode character,
  12     or a double-quoted string; if \code{file = ""} (the default) then the
  13     tree is written on the standard output connection.}
  14   \item{translate}{a logical, if \code{TRUE} (the default) a translation
  15     of the tip labels is done which are replaced in the parenthetic
  16     representation with tokens.}
  17   \item{original.data}{a logical, if \code{TRUE} (the default) the
  18     data in the original NEXUS file are eventually written in
  19     \code{"file"} (see below).}
  20 }
  21 \description{
  22   This function writes trees in a file with the NEXUS format.
  23 }
  24 \details{
  25   If \code{original.data = TRUE}, the file as specified by the attribute
  26   \code{"origin"} of the first tree is read and its data (except the
  27   trees) are written in \code{file}.
  28
  29   If several trees are given, they must have all the same tip labels.
  30
  31   If among the objects given some are not trees of class \code{"phylo"},
  32   they are simply skipped and not written to the file.
  33 }
  34 \value{
  35   None (invisible `NULL').
  36 }
  37 \references{
  38   Maddison, D. R., Swofford, D. L. and Maddison, W. P. (1997) NEXUS: an
  39   extensible file format for systematic information. \emph{Systematic
  40     Biology}, \bold{46}, 590--621.
  41 }
  42
  43 \author{Emmanuel Paradis}
  44 \seealso{
  45   \code{\link{read.nexus}}, \code{\link{read.tree}},
  46   \code{\link{write.tree}}, \code{\link{read.nexus.data}},
  47   \code{\link{write.nexus.data}}
  48 }
  49 \keyword{manip}
  50 \keyword{IO}