tipLength: Calculate distance to tips from ancestors
In eliotmiller/ecoPDcorr: Ecologically-informed phylodiversity metrics

Description Usage Arguments Details Value Note Author(s) See Also Examples

Returns the edge length between each tip and its parent, or alternatively the total distance to each tip from the root node of the phylogeny.

1	tipLength(phy, from=c("parent", "root"))

`phy`	A `phylo4` object (or one that inherits from it)
`from`	Should lengths represent distance from parents only (i.e., simply the lengths of terminal branches), or from the root node?

When from is "parent", the function is a straightforward wrapper of the edgeLength function in the phylobase package. When from is "root", the function uses an implementation of Dijkstra's algorithm to compute the total distance from the root to each of the tips.

Numeric vector of lengths, with the associated tip node labels as names.

When calculating the distance from root, the length of the root edge itself is not included in the returned value. See examples for a simple way to add this additional edge to the result.

Jim Regetz (regetz@nceas.ucsb.edu)

Method edgeLength in the phylobase package.

  data(weeds)
  tipLength(weeds)

  # distance from the root node to each tip
  tipLength(weeds, from="root")

  # as above, but include root edge length
  tipLength(weeds, from="root") + edgeLength(weeds,
    rootNode(weeds))