]> git.donarmstrong.com Git - ape.git/blobdiff - man/rtree.Rd
new code from Pierre Legendre
[ape.git] / man / rtree.Rd
index 264ba5d93e3879b52b31317d81f8b69463cca6ab..5f6a7fd179d5c090c133fa1970e26cfdcbf04b31 100644 (file)
@@ -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}{either an R function used to generate the branch lengths
-    (\code{rtree} or \code{NULL} to give no branch lengths) 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{