'TBRDist' is an R package to compare unrooted phylogenetic trees using the SPR, TBR and Replug distances.
This document assumes familiarity with the process of loading trees into R.
We'll work with some simple trees generated using the 'TreeTools' package.
library('TreeTools', quietly = TRUE, warn.conflicts = FALSE) tree1 <- BalancedTree(10) tree2 <- PectinateTree(10) origPar <- par(mfrow = 1:2, mar = rep(0.2, 4)) # Set up plotting area plot(tree1) plot(tree2)
After installing TBRDist (install.packages('TBRDist')
), load the package into
R with
library('TBRDist')
To generate an approximate SPR distance between two unrooted trees, use:
USPRDist(tree1, tree2)
For Replug distances, it's:
ReplugDist(tree1, tree2)
For TBR distances, use:
TBRDist(tree1, tree2, exact = TRUE)
When calculating an exact TBR distance, we receive information on the maximum agreement forest for free (i.e. with no extra processing cost):
TBRDist(tree1, tree2, exact = TRUE, maf = TRUE)
Once trees have more than about a dozen tips, it becomes slow to calculate the exact distance. In the interests of speed, we may wish to approximate the value of the TBR distance:
TBRDist(tree1, tree2, exact = FALSE)
To avoid multiple calls, each function can also be used to compare lists of
trees (or multiPhylo
objects) against a single tree:
TBRDist(tree1, list(tree1, tree2), exact = TRUE, maf = TRUE)
Or against each corresponding entry in a second list:
USPRDist(list(tree1, tree2, tree2), list(tree2, tree1, tree2))
If you use 'TBRDist' in your research, please cite:
Optionally, a citation to the 'TBRDist' R package would be welcome:
par(origPar)
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.