man/stree.Rd

   1 \name{stree}
   2 \alias{stree}
   3 \title{Generates Systematic Regular Trees}
   4 \usage{
   5 stree(n, type = "star", tip.label = NULL)
   6 }
   7 \arguments{
   8   \item{n}{an integer giving the number of tips in the tree.}
   9   \item{type}{a character string specifying the type of tree to
  10     generate; four choices are possible: \code{"star"},
  11     \code{"balanced"}, \code{"left"}, \code{"right"}, or any unambiguous
  12     abbreviation of these.}
  13   \item{tip.label}{a character vector giving the tip labels; if not
  14     specified, the tips "t1", "t2", ..., are given.}
  15 }
  16 \description{
  17   This function generates trees with regular shapes.
  18 }
  19 \details{
  20   The types of trees generated are:
  21
  22   \itemize{
  23     \item{``star''}{a star (or comb) tree with a single internal node.}
  24     \item{``balanced''}{a fully balanced dichotomous rooted tree;
  25       \code{n} must be a power of 2 (2, 4, 8, \dots).}
  26     \item{``left''}{a fully unbalanced rooted tree where the largest
  27       clade is on the left-hand side when the tree is plotted upwards.}
  28     \item{``right''}{same than above but in the other direction.}
  29   }
  30 }
  31 \value{
  32   An object of class \code{"phylo"}.
  33 }
  34 \author{Emmanuel Paradis}
  35 \seealso{
  36   \code{\link{compute.brlen}}, \code{\link{rtree}}
  37 }
  38 \examples{
  39 layout(matrix(1:4, 2, 2))
  40 plot(stree(100))
  41 plot(stree(128, "balanced"))
  42 plot(stree(100, "left"))
  43 plot(stree(100, "right"))
  44 }
  45 \keyword{datagen}