\alias{rcoal}
\alias{rmtree}
\title{Generates Random Trees}
+\description{
+ These functions generate trees by splitting randomly the edges
+ (\code{rtree}) or randomly clustering the tips (\code{rcoal}).
+ \code{rtree} generates general trees, and \code{rcoal} generates
+ coalescent trees. The algorithms are described in Paradis (2012).
+}
\usage{
rtree(n, rooted = TRUE, tip.label = NULL, br = runif, ...)
rcoal(n, tip.label = NULL, br = "coalescent", ...)
(the default).}
\item{tip.label}{a character vector giving the tip labels; if not
specified, the tips "t1", "t2", ..., are given.}
- \item{br}{an R function used to generate the branch lengths
- (\code{rtree}; use \code{NULL} to simulate only a topology), or the
- coalescence times (\code{rcoal}). For the latter, a genuine
- coalescent tree is simulated by default.}
- \item{...}{further argument(s) to be passed to \code{br}.}
+ \item{br}{one of the following: (i) an \R function used to generate the
+ branch lengths (\code{rtree}; use \code{NULL} to simulate only a
+ topology), or the coalescence times (\code{rcoal}); (ii) a character
+ to simulate a genuine coalescent tree for \code{rcoal} (the
+ default); or (iii) a numeric vector for the branch lengths or the
+ coalescence times.}
+ \item{\dots}{further argument(s) to be passed to \code{br}.}
\item{N}{an integer giving the number of trees to generate.}
}
-\description{
- These functions generate trees by splitting randomly the edges
- (\code{rtree}) or randomly clustering the tips (\code{rcoal}).
- \code{rtree} generates general (non-ultrametric) trees, and
- \code{rcoal} generates coalescent (ultrametric) trees.
-}
\details{
The trees generated are bifurcating. If \code{rooted = FALSE} in
(\code{rtree}), the tree is trifurcating at its root.
An object of class \code{"phylo"} or of class \code{"multiPhylo"} in
the case of \code{rmtree}.
}
-\author{Emmanuel Paradis \email{Emmanuel.Paradis@mpl.ird.fr}}
+\references{
+ Paradis, E. (2012) \emph{Analysis of Phylogenetics and Evolution with
+ R (Second Edition).} New York: Springer.
+}
+\author{Emmanuel Paradis}
+\seealso{
+ \code{\link{stree}}, \code{\link{rlineage}}
+}
\examples{
layout(matrix(1:9, 3, 3))
### Nine random trees: