Flexible clustering for Bioconductor
29 October 2024
Package
bluster 1.16.0
Contents
1 Introduction
The bluster package provides a flexible and extensible framework for clustering in Bioconductor packages/workflows.
At its core is the clusterRows() generic that controls dispatch to different clustering algorithms.
We will demonstrate on some single-cell RNA sequencing data from the scRNAseq package;
our aim is to cluster cells into cell populations based on their PC coordinates.
library(scRNAseq)
sce <- ZeiselBrainData()
# Trusting the authors' quality control, and going straight to normalization.
library(scuttle)
sce <- logNormCounts(sce)
# Feature selection based on highly variable genes.
library(scran)
dec <- modelGeneVar(sce)
hvgs <- getTopHVGs(dec, n=1000)
# Dimensionality reduction for work (PCA) and pleasure (t-SNE).
set.seed(1000)
library(scater)
sce <- runPCA(sce, ncomponents=20, subset_row=hvgs)
sce <- runUMAP(sce, dimred="PCA")
mat <- reducedDim(sce, "PCA")
dim(mat)## [1] 3005 202 Based on distance matrices
2.1 Hierarchical clustering
Our first algorithm is good old hierarchical clustering, as implemented using hclust() from the stats package.
This automatically sets the cut height to half the dendrogram height.
library(bluster)
hclust.out <- clusterRows(mat, HclustParam())
plotUMAP(sce, colour_by=I(hclust.out))
Advanced users can achieve greater control of the procedure by passing more parameters to the HclustParam() constructor.
Here, we use Ward’s criterion for the agglomeration with a dynamic tree cut from the dynamicTreeCut package.
hp2 <- HclustParam(method="ward.D2", cut.dynamic=TRUE)
hp2## class: HclustParam
## metric: [default]
## method: ward.D2
## cut.fun: cutreeDynamic
## cut.params(0):
## dist.fun: stats::dist
## clust.fun: stats::hclusthclust.out <- clusterRows(mat, hp2)
plotUMAP(sce, colour_by=I(hclust.out))
2.2 Affinity propagation
Another option is to use affinity propagation, as implemented using the apcluster package. Here, messages are passed between observations to decide on a set of exemplars, each of which form the center of a cluster.
This is not particularly fast as it involves the calculation of a square similarity matrix between all pairs of observations. So, we’ll speed it up by taking analyzing a subset of the data:
set.seed(1000)
sub <- sce[,sample(ncol(sce), 200)]
ap.out <- clusterRows(reducedDim(sub), AffinityParam())
plotUMAP(sub, colour_by=I(ap.out))
The q parameter is probably the most important and determines the resolution of the clustering.
This can be set to any value below 1, with smaller (possibly negative) values corresponding to coarser clusters.
set.seed(1000)
ap.out <- clusterRows(reducedDim(sub), AffinityParam(q=-2))
plotUMAP(sub, colour_by=I(ap.out))
3 With a fixed number of clusters
3.1 \(k\)-means clustering
A classic algorithm is \(k\)-means clustering, as implemented using the kmeans() function.
This requires us to pass in the number of clusters, either as a number:
set.seed(100)
kmeans.out <- clusterRows(mat, KmeansParam(10))
plotUMAP(sce, colour_by=I(kmeans.out))
Or as a function of the number of observations, which is useful for vector quantization purposes:
kp <- KmeansParam(sqrt)
kp## class: KmeansParam
## centers: variable
## iter.max: 10
## nstart: 1
## algorithm: Hartigan-Wongset.seed(100)
kmeans.out <- clusterRows(mat, kp)
plotUMAP(sce, colour_by=I(kmeans.out))
A variant of this approach is mini-batch \(k\)-means, as implemented in the mbkmeans package. This uses mini-batching to approximate the full \(k\)-means algorithm for greater speed.
set.seed(100)
mbkmeans.out <- clusterRows(mat, MbkmeansParam(20))
plotUMAP(sce, colour_by=I(mbkmeans.out))
3.2 Self-organizing maps
We can also use self-organizing maps (SOMs) from the kohonen package. This allocates observations to nodes of a simple neural network; each node is then treated as a cluster.
set.seed(1000)
som.out <- clusterRows(mat, SomParam(20))
plotUMAP(sce, colour_by=I(som.out))
The key feature of SOMs is that they apply additional topological constraints on the relative positions of the nodes. This allows us to naturally determine the relationships between clusters based on the proximity of the nodes.
set.seed(1000)
som.out <- clusterRows(mat, SomParam(100), full=TRUE)
par(mfrow=c(1,2))
plot(som.out$objects$som, "counts")
grid <- som.out$objects$som$grid$pts
text(grid[,1], grid[,2], seq_len(nrow(grid)))
4 Graph-based clustering
We can build shared or direct nearest neighbor graphs and perform community detection with igraph.
Here, the number of neighbors k controls the resolution of the clusters.
set.seed(101) # just in case there are ties.
graph.out <- clusterRows(mat, NNGraphParam(k=10))
plotUMAP(sce, colour_by=I(graph.out))
It is again straightforward to tune the procedure by passing more arguments such as the community detection algorithm to use.
set.seed(101) # just in case there are ties.
np <- NNGraphParam(k=20, cluster.fun="louvain")
np## class: SNNGraphParam
## k: 20
## type: rank
## BNPARAM: KmknnParam
## num.threads: 1
## cluster.fun: louvain
## cluster.args(0):graph.out <- clusterRows(mat, np)
plotUMAP(sce, colour_by=I(graph.out))
5 Density-based clustering
We also implement a version of the DBSCAN algorithm for density-based clustering. This focuses on identifying masses of continuous density.
dbscan.out <- clusterRows(mat, DbscanParam())
plotUMAP(sce, colour_by=I(dbscan.out))
Unlike the other methods, it will consider certain points to be noise and discard them from the output.
summary(is.na(dbscan.out))## Mode FALSE TRUE
## logical 1789 1216The resolution of the clustering can be modified by tinkering with the core.prop.
Smaller values will generally result in smaller clusters as well as more noise points.
dbscan.out <- clusterRows(mat, DbscanParam(core.prop=0.1))
summary(is.na(dbscan.out))## Mode FALSE TRUE
## logical 565 24406 Two-phase clustering
We also provide a wrapper for a hybrid “two-step” approach for handling larger datasets. Here, a fast agglomeration is performed with \(k\)-means to compact the data, followed by a slower graph-based clustering step to obtain interpretable meta-clusters. (This dataset is not, by and large, big enough for this approach to work particularly well.)
set.seed(100) # for the k-means
two.out <- clusterRows(mat, TwoStepParam())
plotUMAP(sce, colour_by=I(two.out))
Each step is itself parametrized by BlusterParam objects, so it is possible to tune them individually:
twop <- TwoStepParam(second=NNGraphParam(k=5))
twop## class: TwoStepParam
## first:
## class: KmeansParam
## centers: variable
## iter.max: 10
## nstart: 1
## algorithm: Hartigan-Wong
## second:
## class: SNNGraphParam
## k: 5
## type: rank
## BNPARAM: KmknnParam
## num.threads: 1
## cluster.fun: walktrap
## cluster.args(0):set.seed(100) # for the k-means
two.out <- clusterRows(mat, TwoStepParam())
plotUMAP(sce, colour_by=I(two.out))
7 Obtaining full clustering statistics
Sometimes the vector of cluster assignments is not enough.
We can obtain more information about the clustering procedure by setting full=TRUE in clusterRows().
For example, we could obtain the actual graph generated by NNGraphParam():
nn.out <- clusterRows(mat, NNGraphParam(), full=TRUE)
nn.out$objects$graph## IGRAPH ee15620 U-W- 3005 87028 --
## + attr: weight (e/n)
## + edges from ee15620:
## [1] 1-- 2 1-- 3 2-- 3 1-- 4 2-- 4 3-- 4 4-- 5 1-- 5 2-- 5 3-- 5
## [11] 1-- 6 2-- 6 3-- 6 4-- 6 5-- 6 1-- 7 5-- 7 6-- 7 2-- 7 4-- 7
## [21] 3-- 7 3-- 8 1-- 8 2-- 8 4-- 8 6-- 8 7-- 8 5-- 8 1-- 9 2-- 9
## [31] 4-- 9 5-- 9 7-- 9 3-- 9 6-- 9 8-- 9 1--10 5--10 9--10 3--10
## [41] 4--10 3--11 9--11 10--11 1--11 5--11 2--13 5--13 6--13 7--13
## [51] 12--13 8--13 12--14 13--14 12--15 13--15 14--15 2--15 5--15 6--15
## [61] 7--15 12--16 13--16 14--16 15--16 14--17 12--17 15--17 16--17 13--17
## [71] 12--18 14--18 15--18 16--18 13--18 17--18 19--20 12--20 14--20 15--20
## + ... omitted several edgesThe assignment vector is still reported in the clusters entry:
table(nn.out$clusters)##
## 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
## 166 216 256 543 218 89 583 92 123 186 91 42 94 64 58 58 60 35 318 Further comments
clusterRows() enables users or developers to easily switch between clustering algorithms by changing a single argument.
Indeed, by passing the BlusterParam object across functions, we can ensure that the same algorithm is used through a workflow.
It is also helpful for package functions as it provides diverse functionality without compromising a clean function signature.
However, the true power of this framework lies in its extensibility.
Anyone can write a clusterRows() method for a new clustering algorithm with an associated BlusterParam subclass,
and that procedure is immediately compatible with any workflow or function that was already using clusterRows().
Session information
sessionInfo()## R version 4.4.1 (2024-06-14)
## Platform: x86_64-pc-linux-gnu
## Running under: Ubuntu 24.04.1 LTS
##
## Matrix products: default
## BLAS: /home/biocbuild/bbs-3.20-bioc/R/lib/libRblas.so
## LAPACK: /usr/lib/x86_64-linux-gnu/lapack/liblapack.so.3.12.0
##
## locale:
## [1] LC_CTYPE=en_US.UTF-8 LC_NUMERIC=C
## [3] LC_TIME=en_GB LC_COLLATE=C
## [5] LC_MONETARY=en_US.UTF-8 LC_MESSAGES=en_US.UTF-8
## [7] LC_PAPER=en_US.UTF-8 LC_NAME=C
## [9] LC_ADDRESS=C LC_TELEPHONE=C
## [11] LC_MEASUREMENT=en_US.UTF-8 LC_IDENTIFICATION=C
##
## time zone: America/New_York
## tzcode source: system (glibc)
##
## attached base packages:
## [1] stats4 stats graphics grDevices utils datasets methods
## [8] base
##
## other attached packages:
## [1] bluster_1.16.0 scater_1.34.0
## [3] ggplot2_3.5.1 scran_1.34.0
## [5] scuttle_1.16.0 scRNAseq_2.19.1
## [7] SingleCellExperiment_1.28.0 SummarizedExperiment_1.36.0
## [9] Biobase_2.66.0 GenomicRanges_1.58.0
## [11] GenomeInfoDb_1.42.0 IRanges_2.40.0
## [13] S4Vectors_0.44.0 BiocGenerics_0.52.0
## [15] MatrixGenerics_1.18.0 matrixStats_1.4.1
## [17] BiocStyle_2.34.0
##
## loaded via a namespace (and not attached):
## [1] BiocIO_1.16.0 bitops_1.0-9 filelock_1.0.3
## [4] tibble_3.2.1 XML_3.99-0.17 lifecycle_1.0.4
## [7] httr2_1.0.5 edgeR_4.4.0 doParallel_1.0.17
## [10] lattice_0.22-6 ensembldb_2.30.0 alabaster.base_1.6.0
## [13] magrittr_2.0.3 limma_3.62.0 sass_0.4.9
## [16] rmarkdown_2.28 jquerylib_0.1.4 yaml_2.3.10
## [19] metapod_1.14.0 cowplot_1.1.3 DBI_1.2.3
## [22] abind_1.4-8 zlibbioc_1.52.0 AnnotationFilter_1.30.0
## [25] RCurl_1.98-1.16 rappdirs_0.3.3 GenomeInfoDbData_1.2.13
## [28] ggrepel_0.9.6 irlba_2.3.5.1 kohonen_3.0.12
## [31] alabaster.sce_1.6.0 dqrng_0.4.1 codetools_0.2-20
## [34] DelayedArray_0.32.0 tidyselect_1.2.1 UCSC.utils_1.2.0
## [37] farver_2.1.2 gmp_0.7-5 ScaledMatrix_1.14.0
## [40] viridis_0.6.5 BiocFileCache_2.14.0 dynamicTreeCut_1.63-1
## [43] GenomicAlignments_1.42.0 jsonlite_1.8.9 BiocNeighbors_2.0.0
## [46] iterators_1.0.14 foreach_1.5.2 tools_4.4.1
## [49] Rcpp_1.0.13 glue_1.8.0 gridExtra_2.3
## [52] SparseArray_1.6.0 xfun_0.48 dplyr_1.1.4
## [55] HDF5Array_1.34.0 gypsum_1.2.0 withr_3.0.2
## [58] BiocManager_1.30.25 fastmap_1.2.0 rhdf5filters_1.18.0
## [61] fansi_1.0.6 digest_0.6.37 rsvd_1.0.5
## [64] R6_2.5.1 colorspace_2.1-1 RSQLite_2.3.7
## [67] utf8_1.2.4 generics_0.1.3 rtracklayer_1.66.0
## [70] FNN_1.1.4.1 httr_1.4.7 S4Arrays_1.6.0
## [73] uwot_0.2.2 pkgconfig_2.0.3 gtable_0.3.6
## [76] blob_1.2.4 XVector_0.46.0 htmltools_0.5.8.1
## [79] bookdown_0.41 ProtGenerics_1.38.0 scales_1.3.0
## [82] alabaster.matrix_1.6.0 ClusterR_1.3.3 png_0.1-8
## [85] knitr_1.48 rjson_0.2.23 curl_5.2.3
## [88] cachem_1.1.0 rhdf5_2.50.0 BiocVersion_3.20.0
## [91] parallel_4.4.1 vipor_0.4.7 AnnotationDbi_1.68.0
## [94] restfulr_0.0.15 pillar_1.9.0 grid_4.4.1
## [97] alabaster.schemas_1.6.0 vctrs_0.6.5 BiocSingular_1.22.0
## [100] dbplyr_2.5.0 beachmat_2.22.0 cluster_2.1.6
## [103] beeswarm_0.4.0 evaluate_1.0.1 tinytex_0.53
## [106] GenomicFeatures_1.58.0 magick_2.8.5 cli_3.6.3
## [109] locfit_1.5-9.10 compiler_4.4.1 Rsamtools_2.22.0
## [112] rlang_1.1.4 crayon_1.5.3 mbkmeans_1.22.0
## [115] labeling_0.4.3 ggbeeswarm_0.7.2 alabaster.se_1.6.0
## [118] viridisLite_0.4.2 BiocParallel_1.40.0 munsell_0.5.1
## [121] Biostrings_2.74.0 lazyeval_0.2.2 Matrix_1.7-1
## [124] ExperimentHub_2.14.0 benchmarkme_1.0.8 bit64_4.5.2
## [127] Rhdf5lib_1.28.0 KEGGREST_1.46.0 statmod_1.5.0
## [130] alabaster.ranges_1.6.0 highr_0.11 apcluster_1.4.13
## [133] AnnotationHub_3.14.0 igraph_2.1.1 memoise_2.0.1
## [136] bslib_0.8.0 benchmarkmeData_1.0.4 bit_4.5.0