new speciesTree()

[ape.git] / man / rtree.Rd

diff --git a/man/rtree.Rd b/man/rtree.Rd
index 48401b5b8341e8a15b439ecbc0a2f599db763319..05a1fbea45e92ddd4bf67263fd44fa828de8dd14 100644 (file)
--- a/man/rtree.Rd
+++ b/man/rtree.Rd
@@ -14,11 +14,13 @@ rmtree(N, n, rooted = TRUE, tip.label = NULL, br = runif, ...)
     (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{
@@ -42,7 +44,10 @@ rmtree(N, n, rooted = TRUE, tip.label = NULL, br = runif, ...)
   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}}
+\author{Emmanuel Paradis}
+\seealso{
+  \code{\link{stree}}
+}
 \examples{
 layout(matrix(1:9, 3, 3))
 ### Nine random trees: