File: stree.Rd

package info (click to toggle)
r-cran-ape 5.7-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 3,932 kB
  • sloc: ansic: 7,626; cpp: 116; sh: 17; makefile: 2
file content (45 lines) | stat: -rw-r--r-- 1,364 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
\name{stree}
\alias{stree}
\title{Generates Systematic Regular Trees}
\usage{
stree(n, type = "star", tip.label = NULL)
}
\arguments{
  \item{n}{an integer giving the number of tips in the tree.}
  \item{type}{a character string specifying the type of tree to
    generate; four choices are possible: \code{"star"},
    \code{"balanced"}, \code{"left"}, \code{"right"}, or any unambiguous
    abbreviation of these.}
  \item{tip.label}{a character vector giving the tip labels; if not
    specified, the tips "t1", "t2", ..., are given.}
}
\description{
  This function generates trees with regular shapes.
}
\details{
  The types of trees generated are:

  \itemize{
    \item{``star''}{a star (or comb) tree with a single internal node.}
    \item{``balanced''}{a fully balanced dichotomous rooted tree;
      \code{n} must be a power of 2 (2, 4, 8, \dots).}
    \item{``left''}{a fully unbalanced rooted tree where the largest
      clade is on the left-hand side when the tree is plotted upwards.}
    \item{``right''}{same than above but in the other direction.}
  }
}
\value{
  An object of class \code{"phylo"}.
}
\author{Emmanuel Paradis}
\seealso{
  \code{\link{compute.brlen}}, \code{\link{rtree}}
}
\examples{
layout(matrix(1:4, 2, 2))
plot(stree(100))
plot(stree(128, "balanced"))
plot(stree(100, "left"))
plot(stree(100, "right"))
}
\keyword{datagen}