]> git.donarmstrong.com Git - ape.git/blob - man/write.nexus.Rd
final commit for ape 3.0
[ape.git] / 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 = NULL)
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}{deprecated; will be removed soon.}
18 }
19 \description{
20   This function writes trees in a file with the NEXUS format.
21 }
22 \details{
23   If several trees are given, they must have all the same tip labels.
24
25   If among the objects given some are not trees of class \code{"phylo"},
26   they are simply skipped and not written to the file.
27 }
28 \value{
29   None (invisible `NULL').
30 }
31 \references{
32   Maddison, D. R., Swofford, D. L. and Maddison, W. P. (1997) NEXUS: an
33   extensible file format for systematic information. \emph{Systematic
34     Biology}, \bold{46}, 590--621.
35 }
36
37 \author{Emmanuel Paradis}
38 \seealso{
39   \code{\link{read.nexus}}, \code{\link{read.tree}},
40   \code{\link{write.tree}}, \code{\link{read.nexus.data}},
41   \code{\link{write.nexus.data}}
42 }
43 \keyword{manip}
44 \keyword{IO}