The hierBAPS algorithm was introduced in (Cheng et al. 2013) and provides a method for hierarchically clustering DNA sequence data to reveal nested population structure. Previously the algorithm was available as a compiled MATLAB binary. We provide a convenient R implementation and include a number of useful additional options including the ability to use multiple cores, save the log marginal likelihood scores and run the algorithm until local convergence. Furthermore, we provide a wrapper to a ggtree plotting function allowing for easy exploration of sub-clusters.
Things to keep in mind before running hierBAPS
library(rhierbaps) library(ggtree) library(phytools) library(ape) set.seed(1234)
We first need to load a multiple sequence alignment in fasta format. We can then generate the required SNP matrix.
fasta.file.name <- system.file("extdata", "seqs.fa", package = "rhierbaps") snp.matrix <- load_fasta(fasta.file.name)
If you wish to include singleton SNPs (those that appear in only one
isolate) then set
keep.singletons=FALSE. However, this is
currently advised against as these SNPs lead to a higher number of
parameters in the model and do not provide information about shared
It is also possible to load an ape DNAbin object. Here me make use of the woodmouse dataset in ape.
data(woodmouse) woodmouse.snp.matrix <- load_fasta(woodmouse)
We now need to decide how many levels of clustering we are interested
in and the number of initial clusters to start from. It is a good idea
n.pops to be significantly larger than the number
of clusters you expect.
To run hierBAPS with \(2\) levels and \(20\) initial clusters we run
hb.results <- hierBAPS(snp.matrix, max.depth = 2, n.pops = 20, quiet = TRUE) head(hb.results$partition.df)
## Isolate level 1 level 2 ## 1 1 1 1 ## 2 2 1 1 ## 3 3 1 1 ## 4 4 2 5 ## 5 5 3 9 ## 6 6 3 9
This produces a list which includes a data frame indicating the resulting partition of the isolates at the difference levels. The isolate names in this data frame are taken from the fasta headers and thus for plotting it is important that these match the isolate names in any tree used later. This function also outputs the log marginal likelihoods at the different levels of clustering.
hierBAPS can also be run until the algorithm converges to a local optimum as
hb.results <- hierBAPS(snp.matrix, max.depth = 2, n.pops = 20, n.extra.rounds = Inf, quiet = TRUE)
We can also check how long hierBAPS takes to run on the test dataset of 515 samples and 744 SNPs.
system.time(hierBAPS(snp.matrix, max.depth = 2, n.pops = 20, quiet = TRUE))
## user system elapsed ## 84.334 15.494 100.946
To plot the results it is useful to consider a tree of the same isolates. We clustered the example isolates using Iqtree (Kalyaanamoorthy et al. 2017). The ggtree (Yu et al. 2017) package then allows us to plot the results.
First we need to load the newick file.
newick.file.name <- system.file("extdata", "seqs.fa.treefile", package = "rhierbaps") iqtree <- phytools::read.newick(newick.file.name)
A simple coloured tree allows us to see the top level cluster assignment from hierBAPS.
gg <- ggtree(iqtree, layout = "circular") gg <- gg %<+% hb.results$partition.df gg <- gg + geom_tippoint(aes(color = factor(`level 1`))) gg
As there are many more clusters at the second level using colours to distinguish them can get confusing. Instead we can label the tips with their corresponding clusters.
gg <- ggtree(iqtree, layout = "circular", branch.length = "none") gg <- gg %<+% hb.results$partition.df gg <- gg + geom_tippoint(aes(color = factor(`level 1`))) gg <- gg + theme(legend.position = "right") gg <- gg + geom_tiplab(aes(label = `level 2`), size = 1, offset = 1) gg