knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.width=7,
  fig.height=11
)

treestructure

Citation

Identification of hidden population structure in time-scaled phylogenies

Erik Volz, Carsten Wiuf, Yonatan Grad, Simon Frost, Ann Dennis, Xavier Didelot, bioRxiv 704528; https://doi.org/10.1101/704528

Structured coalescent simulation

This example shows trestruct applied to a simulated structured coalescent tree that includes samples from a large constant size population and samples from three small 'outbreaks' which are growing exponentially. These simulations were generated with the phydynR package.

library(treestructure)

Load the tree:

( tree <- ape::read.tree( system.file('sim.nwk', package='treestructure') ) ) 

Note that the tip labels corresponds to the deme of each sample. '1' is the constant size reservoir, and '0' is the exponentially growing deme.

This will run the treestructure algorithm under default setting:

s <- trestruct( tree ) 

You can print the results:

print(s) 

The default plotting behavior uses the ggtree package if available.

plot(s)  + ggtree::geom_tiplab() 

If not, or if desired, ape plots are available

plot( s, use_ggtree = FALSE )

For subsequent analysis, you may want to turn the treestructure result into a dataframe:

structureData <- as.data.frame( s ) 
head( structureData )

Each cluster and partition assignment is stored as a factor. You could use split to get a data frame for each partition. Suppose we want a tree corresponding to partition 1:

with ( structureData, 
    ape::keep.tip(s$tree,  taxon[ partition==1 ] ) 
) -> partition1
partition1
plot(partition1)

Two parameters will have large influence on results:

  1. level is the significance level for subdividing a clade into a new cluster. To detect more clusters, increase p, but note that this will also increase the false positive rate.
  2. minCladeSize controls the smallest allowed cluster size in terms of the number of tips. With a smaller value, smaller clusters may be detected, but computation time will increase.

Example:

trestruct( tree, level = .05, minCladeSize = 5 )

In practice, clustering thresholds are always subjective and the best value of the level parameter will depend on your application. One way to choose an appropriate level would be to use additional data associated with each sample. You can select the level which gives a set of clusters that explains the most variance in the data of interest (e.g. use the cluster as a factor in an ANOVA). Alternatively, in the absence of any additional data, the treestructure package supports using the CH index (\url{https://en.wikipedia.org/wiki/Calinski–Harabasz_index}) to compare different levels. This statistic is based on the ratio of the between-cluster and within-cluster variance of the time of each node (distance from the root) and returns the level such that this ratio is maximised. If you wish to use the CH index, pass level=NULL to trestruct, and read documentation for the levellb,levelub, and res parameters.



emvolz-phylodynamics/treestructure documentation built on March 1, 2025, 3:47 p.m.