File: node.depth.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 (38 lines) | stat: -rw-r--r-- 1,201 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
\name{node.depth}
\alias{node.depth}
\alias{node.depth.edgelength}
\alias{node.height}
\title{Depth and Heights of Nodes and Tips}
\description{
  These functions return the depths or heights of nodes and tips.
}
\usage{
node.depth(phy, method = 1)
node.depth.edgelength(phy)
node.height(phy, clado.style = FALSE)
}
\arguments{
  \item{phy}{an object of class "phylo".}
  \item{method}{an integer value (1 or 2); 1: the node depths are
    proportional to the number of tips descending from each node, 2:
    they are evenly spaced.}
  \item{clado.style}{a logical value; if \code{TRUE}, the node heights
    are calculated for a cladogram.}
}
\details{
  \code{node.depth} computes the depth of a node depending on the value
  of \code{method} (see the option \code{node.depth} in
  \code{\link{plot.phylo}}). The value of 1 is given to the tips.

  \code{node.depth.edgelength} does the same but using branch lengths.

  \code{node.height} computes the heights of nodes and tips as plotted
  by a phylogram or a cladogram.
}
\value{
  A numeric vector indexed with the node numbers of the matrix `edge' of
  \code{phy}.
}
\author{Emmanuel Paradis}
\seealso{\code{\link{plot.phylo}}}
\keyword{manip}