X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=man%2Frtree.Rd;h=b30109cdcbf86eafcd99942067edb0ab04f497fb;hb=7af63afb401f7cc82816b0af19e21c43fab49674;hp=264ba5d93e3879b52b31317d81f8b69463cca6ab;hpb=d88302b4735b5b7c9132387090bb592d906fe1cb;p=ape.git diff --git a/man/rtree.Rd b/man/rtree.Rd index 264ba5d..b30109c 100644 --- 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}{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{ @@ -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}}, \code{\link{rlineage}} +} \examples{ layout(matrix(1:9, 3, 3)) ### Nine random trees: