new function rmtree

[ape.git] / man / rtree.Rd

diff --git a/man/rtree.Rd b/man/rtree.Rd
index 96116f97babc93425b814f0bdcea06f70b8631fa..63cbf79e5f8a2c1f74602c0845be3140bb2f5fdc 100644 (file)
--- a/man/rtree.Rd
+++ b/man/rtree.Rd
@@ -5,6 +5,7 @@
 \usage{
 rtree(n, rooted = TRUE, tip.label = NULL, br = runif, ...)
 rcoal(n, tip.label = NULL, br = rexp, ...)
+rmtree(N, n, rooted = TRUE, tip.label = NULL, br = runif, ...)
 }
 \arguments{
   \item{n}{an integer giving the number of tips in the tree.}
@@ -16,6 +17,7 @@ rcoal(n, tip.label = NULL, br = rexp, ...)
     (\code{rtree}) or the coalescence times (\code{rcoal}), or
     \code{NULL} to give no branch lengths in the tree.}
   \item{...}{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
@@ -31,6 +33,13 @@ rcoal(n, tip.label = NULL, br = rexp, ...)
   \code{runif}. In \code{rcoal} \code{rexp} is used to generate the
   inter-node distances. If further arguments are passed to \code{br},
   they need to be tagged (e.g., \code{min = 0, max = 10}).
+
+  \code{rmtree} calls successively \code{rmtree} and set the class of
+  the returned object appropriately.
+}
+\value{
+  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}}
 \examples{