Description Usage Arguments Value Author(s)
These helper functions are unlikely to be of day-to-day use, but are exported in case they are valuable to package developers.
1 2 3 | .CatchBadPair(i, tree1, tree2)
.DistReturn(ret, tree1, tree2, allPairs)
|
i |
Integer iterating tree pair. |
tree1, tree2 |
Trees of class |
ret |
A list containing the results of a tree comparison, probably performed in C. Each element of the list will correspond to an aspect of tree distance (e.g. TBR distance, MAF composition). |
allPairs |
Logical specifying whether all trees were compared with all
other trees, in which case a structure of class |
.CatchBadPair()
returns integer(0)
, but will stop
R with an
error message if the labels of tree1
and tree2
differ in anything but
order.
.DistReturn()
returns a structure of class numeric
, matrix
or
dist
containing the distances between each pair of trees.
Martin R. Smith (martin.smith@durham.ac.uk)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.