Using UCell with Seurat
1 November 2024
Package
UCell 2.11.1
1 Introduction
The function AddModuleScore_UCell() allows operating directly on Seurat objects. UCell scores are calculated from raw counts or normalized data, and returned as metadata columns. The example below defines some simple signatures, and applies them on single-cell data stored in a Seurat object.
To see how this function differs from Seurat’s own AddModuleScore() (not based on per-cell ranks) see this vignette.
2 Get some testing data
For this demo, we will download a single-cell dataset of lung cancer (Zilionis et al. (2019) Immunity) through the scRNA-seq package. This dataset contains >170,000 single cells; for the sake of simplicity, in this demo will we focus on immune cells, according to the annotations by the authors, and downsample to 5000 cells.
library(scRNAseq)
lung <- ZilionisLungData()
immune <- lung$Used & lung$used_in_NSCLC_immune
lung <- lung[,immune]
lung <- lung[,1:5000]
exp.mat <- Matrix::Matrix(counts(lung),sparse = TRUE)
colnames(exp.mat) <- paste0(colnames(exp.mat), seq(1,ncol(exp.mat)))3 Define gene signatures
Here we define some simple gene sets based on the “Human Cell Landscape” signatures Han et al. (2020) Nature. You may edit existing signatures, or add new one as elements in a list.
signatures <- list(
Tcell = c("CD3D","CD3E","CD3G","CD2","TRAC"),
Myeloid = c("CD14","LYZ","CSF1R","FCER1G","SPI1","LCK-"),
NK = c("KLRD1","NCR1","NKG7","CD3D-","CD3E-"),
Plasma_cell = c("MZB1","DERL3","CD19-")
)4 Run UCell on Seurat object
library(UCell)
library(Seurat)
seurat.object <- CreateSeuratObject(counts = exp.mat,
project = "Zilionis_immune")
seurat.object <- AddModuleScore_UCell(seurat.object,
features=signatures, name=NULL)
head(seurat.object[[]])## orig.ident nCount_RNA nFeature_RNA Tcell Myeloid NK Plasma_cell
## bcHTNA1 Zilionis_immune 7516 2613 0 0.5227121 0 0.00000000
## bcHNVA2 Zilionis_immune 5684 1981 0 0.5112892 0 0.00000000
## bcALZN3 Zilionis_immune 4558 1867 0 0.3584502 0 0.07540874
## bcFWBP4 Zilionis_immune 2915 1308 0 0.1546426 0 0.00000000
## bcBJYE5 Zilionis_immune 3576 1548 0 0.4629927 0 0.00000000
## bcGSBJ6 Zilionis_immune 2796 1270 0 0.5452238 0 0.00000000Generate PCA and UMAP embeddings
seurat.object <- NormalizeData(seurat.object)
seurat.object <- FindVariableFeatures(seurat.object,
selection.method = "vst", nfeatures = 500)
seurat.object <- ScaleData(seurat.object)
seurat.object <- RunPCA(seurat.object, npcs = 20,
features=VariableFeatures(seurat.object))
seurat.object <- RunUMAP(seurat.object, reduction = "pca",
dims = 1:20, seed.use=123)Visualize UCell scores on low-dimensional representation (UMAP)
library(ggplot2)
library(patchwork)
FeaturePlot(seurat.object, reduction = "umap", features = names(signatures))
5 Signature smoothing
Single-cell data are sparse. It can be useful to ‘impute’ scores by neighboring cells and partially correct this sparsity. The function SmoothKNN performs smoothing of single-cell scores by weighted average of the k-nearest neighbors in a given dimensionality reduction. It can be applied directly on Seurat objects to smooth UCell scores:
seurat.object <- SmoothKNN(seurat.object,
signature.names = names(signatures),
reduction="pca")FeaturePlot(seurat.object, reduction = "umap", features = c("NK","NK_kNN"))
Smoothing (or imputation) has been designed for UCell scores, but it can be applied to any other data or metadata. For instance, we can perform knn-smoothing directly on gene expression measurements:
genes <- c("CD2","CSF1R")
seurat.object <- SmoothKNN(seurat.object, signature.names=genes,
assay="RNA", reduction="pca", k=20, suffix = "_smooth")
DefaultAssay(seurat.object) <- "RNA"
a <- FeaturePlot(seurat.object, reduction = "umap", features = genes)
DefaultAssay(seurat.object) <- "RNA_smooth"
b <- FeaturePlot(seurat.object, reduction = "umap", features = genes)
a / b
6 Resources
Please report any issues at the UCell GitHub repository.
More demos available on the Bioc landing page and at the UCell demo repository.
If you find UCell useful, you may also check out the scGate package, which relies on UCell scores to automatically purify populations of interest based on gene signatures.
See also SignatuR for easy storing and retrieval of gene signatures.
7 References
Appendix
- Andreatta, M., Carmona, S. J. (2021) UCell: Robust and scalable single-cell gene signature scoring Computational and Structural Biotechnology Journal
- Zilionis, R., Engblom, C., …, Klein, A. M. (2019) Single-Cell Transcriptomics of Human and Mouse Lung Cancers Reveals Conserved Myeloid Populations across Individuals and Species Immunity
- Hao, Yuhan, et al. (2021) Integrated analysis of multimodal single-cell data Cell
A Session Info
sessionInfo()## R Under development (unstable) (2024-10-21 r87258)
## Platform: x86_64-pc-linux-gnu
## Running under: Ubuntu 24.04.1 LTS
##
## Matrix products: default
## BLAS: /home/biocbuild/bbs-3.21-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] patchwork_1.3.0 ggplot2_3.5.1
## [3] Seurat_5.1.0 SeuratObject_5.0.2
## [5] sp_2.1-4 UCell_2.11.1
## [7] scRNAseq_2.19.1 SingleCellExperiment_1.29.0
## [9] SummarizedExperiment_1.37.0 Biobase_2.67.0
## [11] GenomicRanges_1.59.0 GenomeInfoDb_1.43.0
## [13] IRanges_2.41.0 S4Vectors_0.45.0
## [15] BiocGenerics_0.53.1 generics_0.1.3
## [17] MatrixGenerics_1.19.0 matrixStats_1.4.1
## [19] BiocStyle_2.35.0
##
## loaded via a namespace (and not attached):
## [1] RcppAnnoy_0.0.22 later_1.3.2 splines_4.5.0
## [4] BiocIO_1.17.0 bitops_1.0-9 filelock_1.0.3
## [7] tibble_3.2.1 polyclip_1.10-7 XML_3.99-0.17
## [10] fastDummies_1.7.4 lifecycle_1.0.4 httr2_1.0.5
## [13] globals_0.16.3 lattice_0.22-6 ensembldb_2.31.0
## [16] MASS_7.3-61 alabaster.base_1.7.0 magrittr_2.0.3
## [19] plotly_4.10.4 sass_0.4.9 rmarkdown_2.28
## [22] jquerylib_0.1.4 yaml_2.3.10 httpuv_1.6.15
## [25] sctransform_0.4.1 spam_2.11-0 spatstat.sparse_3.1-0
## [28] reticulate_1.39.0 pbapply_1.7-2 cowplot_1.1.3
## [31] DBI_1.2.3 RColorBrewer_1.1-3 abind_1.4-8
## [34] zlibbioc_1.53.0 Rtsne_0.17 purrr_1.0.2
## [37] AnnotationFilter_1.31.0 RCurl_1.98-1.16 rappdirs_0.3.3
## [40] GenomeInfoDbData_1.2.13 ggrepel_0.9.6 irlba_2.3.5.1
## [43] spatstat.utils_3.1-0 listenv_0.9.1 alabaster.sce_1.7.0
## [46] goftest_1.2-3 RSpectra_0.16-2 spatstat.random_3.3-2
## [49] fitdistrplus_1.2-1 parallelly_1.38.0 leiden_0.4.3.1
## [52] codetools_0.2-20 DelayedArray_0.33.1 tidyselect_1.2.1
## [55] farver_2.1.2 UCSC.utils_1.3.0 spatstat.explore_3.3-3
## [58] BiocFileCache_2.15.0 GenomicAlignments_1.43.0 jsonlite_1.8.9
## [61] BiocNeighbors_2.1.0 progressr_0.15.0 ggridges_0.5.6
## [64] survival_3.7-0 tools_4.5.0 ica_1.0-3
## [67] Rcpp_1.0.13 glue_1.8.0 gridExtra_2.3
## [70] SparseArray_1.7.0 xfun_0.49 dplyr_1.1.4
## [73] HDF5Array_1.35.1 gypsum_1.3.0 withr_3.0.2
## [76] BiocManager_1.30.25 fastmap_1.2.0 rhdf5filters_1.19.0
## [79] fansi_1.0.6 digest_0.6.37 mime_0.12
## [82] R6_2.5.1 colorspace_2.1-1 scattermore_1.2
## [85] tensor_1.5 spatstat.data_3.1-2 RSQLite_2.3.7
## [88] tidyr_1.3.1 utf8_1.2.4 data.table_1.16.2
## [91] rtracklayer_1.67.0 htmlwidgets_1.6.4 httr_1.4.7
## [94] S4Arrays_1.7.1 uwot_0.2.2 pkgconfig_2.0.3
## [97] gtable_0.3.6 blob_1.2.4 lmtest_0.9-40
## [100] XVector_0.47.0 htmltools_0.5.8.1 dotCall64_1.2
## [103] bookdown_0.41 ProtGenerics_1.39.0 scales_1.3.0
## [106] alabaster.matrix_1.7.0 png_0.1-8 spatstat.univar_3.0-1
## [109] knitr_1.48 reshape2_1.4.4 rjson_0.2.23
## [112] nlme_3.1-166 curl_5.2.3 cachem_1.1.0
## [115] zoo_1.8-12 rhdf5_2.51.0 stringr_1.5.1
## [118] BiocVersion_3.21.1 KernSmooth_2.23-24 parallel_4.5.0
## [121] miniUI_0.1.1.1 AnnotationDbi_1.69.0 restfulr_0.0.15
## [124] pillar_1.9.0 grid_4.5.0 alabaster.schemas_1.7.0
## [127] vctrs_0.6.5 RANN_2.6.2 promises_1.3.0
## [130] dbplyr_2.5.0 xtable_1.8-4 cluster_2.1.6
## [133] evaluate_1.0.1 magick_2.8.5 tinytex_0.54
## [136] GenomicFeatures_1.59.0 cli_3.6.3 compiler_4.5.0
## [139] Rsamtools_2.23.0 rlang_1.1.4 crayon_1.5.3
## [142] future.apply_1.11.3 labeling_0.4.3 plyr_1.8.9
## [145] stringi_1.8.4 deldir_2.0-4 viridisLite_0.4.2
## [148] alabaster.se_1.7.0 BiocParallel_1.41.0 munsell_0.5.1
## [151] Biostrings_2.75.0 lazyeval_0.2.2 spatstat.geom_3.3-3
## [154] Matrix_1.7-1 ExperimentHub_2.15.0 RcppHNSW_0.6.0
## [157] bit64_4.5.2 future_1.34.0 Rhdf5lib_1.29.0
## [160] KEGGREST_1.47.0 shiny_1.9.1 highr_0.11
## [163] alabaster.ranges_1.7.0 AnnotationHub_3.15.0 ROCR_1.0-11
## [166] igraph_2.1.1 memoise_2.0.1 bslib_0.8.0
## [169] bit_4.5.0