Installation
To install the developmental version of the package, run:
install.packages("devtools")
devtools::install_github("omnideconv/SimBu")
To install from Bioconductor:
if (!require("BiocManager", quietly = TRUE)) {
install.packages("BiocManager")
}
BiocManager::install("SimBu")
Introduction
As complex tissues are typically composed of various cell types,
deconvolution tools have been developed to computationally infer their
cellular composition from bulk RNA sequencing (RNA-seq) data. To
comprehensively assess deconvolution performance, gold-standard datasets
are indispensable. Gold-standard, experimental techniques like flow
cytometry or immunohistochemistry are resource-intensive and cannot be
systematically applied to the numerous cell types and tissues profiled
with high-throughput transcriptomics. The simulation of ‘pseudo-bulk’
data, generated by aggregating single-cell RNA-seq (scRNA-seq)
expression profiles in pre-defined proportions, offers a scalable and
cost-effective alternative. This makes it feasible to create in silico
gold standards that allow fine-grained control of cell-type fractions
not conceivable in an experimental setup. However, at present, no
simulation software for generating pseudo-bulk RNA-seq data
exists.
SimBu was developed to simulate pseudo-bulk samples based on various
simulation scenarios, designed to test specific features of
deconvolution methods. A unique feature of SimBu is the modelling of
cell-type-specific mRNA bias using experimentally-derived or data-driven
scaling factors. Here, we show that SimBu can generate realistic
pseudo-bulk data, recapitulating the biological and statistical features
of real RNA-seq data. Finally, we illustrate the impact of mRNA bias on
the evaluation of deconvolution tools and provide recommendations for
the selection of suitable methods for estimating mRNA content.
Getting started
This chapter covers all you need to know to quickly simulate some
pseudo-bulk samples!
This package can simulate samples from local or public data. This
vignette will work with artificially generated data as it serves as an
overview for the features implemented in SimBu. For the public data
integration using sfaira (Fischer et al.
2020), please refer to the “Public Data Integration”
vignette.
We will create some toy data to use for our simulations; two matrices with 300 cells each and 1000 genes/features. One represents raw count data, while the other matrix represents scaled TPM-like data. We will assign these cells to some immune cell types.
counts <- Matrix::Matrix(matrix(rpois(3e5, 5), ncol = 300), sparse = TRUE)
tpm <- Matrix::Matrix(matrix(rpois(3e5, 5), ncol = 300), sparse = TRUE)
tpm <- Matrix::t(1e6 * Matrix::t(tpm) / Matrix::colSums(tpm))
colnames(counts) <- paste0("cell_", rep(1:300))
colnames(tpm) <- paste0("cell_", rep(1:300))
rownames(counts) <- paste0("gene_", rep(1:1000))
rownames(tpm) <- paste0("gene_", rep(1:1000))
annotation <- data.frame(
"ID" = paste0("cell_", rep(1:300)),
"cell_type" = c(
rep("T cells CD4", 50),
rep("T cells CD8", 50),
rep("Macrophages", 100),
rep("NK cells", 10),
rep("B cells", 70),
rep("Monocytes", 20)
)
)
Creating a dataset
SimBu uses the SummarizedExperiment
class as storage for count data as well as annotation data. Currently it
is possible to store two matrices at the same time: raw counts and
TPM-like data (this can also be some other scaled count matrix, such as
RPKM, but we recommend to use TPMs). These two matrices have to have the
same dimensions and have to contain the same genes and cells. Providing
the raw count data is mandatory!
SimBu scales the matrix that is added via the tpm_matrix
slot by default to 1e6 per cell, if you do not want this, you can switch
it off by setting the scale_tpm
parameter to
FALSE
. Additionally, the cell type annotation of the cells
has to be given in a dataframe, which has to include the two columns
ID
and cell_type
. If additional columns from
this annotation should be transferred to the dataset, simply give the
names of them in the additional_cols
parameter.
To generate a dataset that can be used in SimBu, you can use the
dataset()
method; other methods exist as well, which are
covered in the “Inputs &
Outputs” vignette.
ds <- SimBu::dataset(
annotation = annotation,
count_matrix = counts,
tpm_matrix = tpm,
name = "test_dataset"
)
#> Filtering genes...
#> Created dataset.
SimBu offers basic filtering options for your dataset, which you can
apply during dataset generation:
filter_genes: if TRUE, genes which have expression values of 0 in all cells will be removed.
variance_cutoff: remove all genes with a expression variance below the chosen cutoff.
type_abundance_cutoff: remove all cells, which belong to a cell type that appears less the the given amount.
Simulate pseudo bulk datasets
We are now ready to simulate the first pseudo bulk samples with the created dataset:
simulation <- SimBu::simulate_bulk(
data = ds,
scenario = "random",
scaling_factor = "NONE",
ncells = 100,
nsamples = 10,
BPPARAM = BiocParallel::MulticoreParam(workers = 4), # this will use 4 threads to run the simulation
run_parallel = TRUE
) # multi-threading to TRUE
#> Using parallel generation of simulations.
#> Finished simulation.
ncells
sets the number of cells in each sample, while
nsamples
sets the total amount of simulated samples.
If you want to simulate a specific sequencing depth in your simulations,
you can use the total_read_counts
parameter to do so. Note
that this parameter is only applied on the counts matrix (if supplied),
as TPMs will be scaled to 1e6 by default.
SimBu can add mRNA bias by using different scaling factors to the
simulations using the scaling_factor
parameter. A detailed
explanation can be found in the “Scaling factor”
vignette.
Currently there are 6 scenarios
implemented in the
package:
even: this creates samples, where all existing cell-types in the dataset appear in the same proportions. So using a dataset with 3 cell-types, this will simulate samples, where all cell-type fractions are 1/3. In order to still have a slight variation between cell type fractions, you can increase the
balance_uniform_mirror_scenario
parameter (default to 0.01). Setting it to 0 will generate simulations with exactly the same cell type fractions.random: this scenario will create random cell type fractions using all present types for each sample. The random sampling is based on the uniform distribution.
mirror_db: this scenario will mirror the exact fractions of cell types which are present in the provided dataset. If it consists of 20% T cells, 30% B cells and 50% NK cells, all simulated samples will mirror these fractions. Similar to the uniform scenario, you can add a small variation to these fractions with the
balance_uniform_mirror_scenario
parameter.weighted: here you need to set two additional parameters for the
simulate_bulk()
function:weighted_cell_type
sets the cell-type you want to be over-representing andweighted_amount
sets the fraction of this cell-type. You could for example useB-cell
and0.5
to create samples, where 50% are B-cells and the rest is filled randomly with other cell-types.pure: this creates simulations of only one single cell-type. You have to provide the name of this cell-type with the
pure_cell_type
parameter.custom: here you are able to create your own set of cell-type fractions. When using this scenario, you additionally need to provide a dataframe in the
custom_scenario_data
parameter, where each row represents one sample (therefore the number of rows need to match thensamples
parameter). Each column has to represent one cell-type, which also occurs in the dataset and describes the fraction of this cell-type in a sample. The fractions per sample need to sum up to 1. An example can be seen here:
pure_scenario_dataframe <- data.frame(
"B cells" = c(0.2, 0.1, 0.5, 0.3),
"T cells" = c(0.3, 0.8, 0.2, 0.5),
"NK cells" = c(0.5, 0.1, 0.3, 0.2),
row.names = c("sample1", "sample2", "sample3", "sample4")
)
pure_scenario_dataframe
#> B.cells T.cells NK.cells
#> sample1 0.2 0.3 0.5
#> sample2 0.1 0.8 0.1
#> sample3 0.5 0.2 0.3
#> sample4 0.3 0.5 0.2
Results
The simulation
object contains three named
entries:
-
bulk
: a SummarizedExperiment object with the pseudo-bulk dataset(s) stored in theassays
. They can be accessed like this:
head(SummarizedExperiment::assays(simulation$bulk)[["bulk_counts"]])
#> 6 x 10 sparse Matrix of class "dgCMatrix"
#> [[ suppressing 10 column names 'random_sample1', 'random_sample2', 'random_sample3' ... ]]
#>
#> gene_1 502 505 519 480 508 529 541 496 530 505
#> gene_2 444 473 433 401 475 415 494 469 449 464
#> gene_3 457 519 456 465 449 465 489 527 514 458
#> gene_4 492 512 490 463 486 470 509 449 428 495
#> gene_5 513 513 505 505 518 504 526 554 505 499
#> gene_6 477 500 512 574 481 549 456 497 486 463
head(SummarizedExperiment::assays(simulation$bulk)[["bulk_tpm"]])
#> 6 x 10 sparse Matrix of class "dgCMatrix"
#> [[ suppressing 10 column names 'random_sample1', 'random_sample2', 'random_sample3' ... ]]
#>
#> gene_1 991.3409 1044.8757 1017.2083 1075.1807 1046.0474 942.5984 954.5384
#> gene_2 906.8074 1008.5754 927.7449 941.8023 986.0652 944.3532 970.3278
#> gene_3 941.8825 935.7061 981.1682 1086.2295 988.0847 972.3417 911.5607
#> gene_4 860.4382 979.2411 963.7702 908.1066 955.9696 944.0623 861.5481
#> gene_5 1158.3326 998.3309 1082.2137 1054.0071 1049.9490 1110.4548 988.9435
#> gene_6 925.2414 993.6818 1025.5998 985.7396 982.3033 948.0573 1033.4023
#>
#> gene_1 1005.9698 925.2913 1015.6309
#> gene_2 869.6468 857.0933 927.7474
#> gene_3 1041.2172 979.9720 873.5532
#> gene_4 865.6604 926.2193 974.0801
#> gene_5 1016.3162 999.9083 969.6560
#> gene_6 1004.4536 1064.9110 1210.6062
If only a single matrix was given to the dataset initially, only one assay is filled.
cell_fractions
: a table where rows represent the simulated samples and columns represent the different simulated cell-types. The entries in the table store the specific cell-type fraction per sample.scaling_vector
: a named list, with the used scaling value for each cell from the single cell dataset.
It is also possible to merge simulations:
simulation2 <- SimBu::simulate_bulk(
data = ds,
scenario = "even",
scaling_factor = "NONE",
ncells = 1000,
nsamples = 10,
BPPARAM = BiocParallel::MulticoreParam(workers = 4),
run_parallel = TRUE
)
#> Using parallel generation of simulations.
#> Finished simulation.
merged_simulations <- SimBu::merge_simulations(list(simulation, simulation2))
Finally here is a barplot of the resulting simulation:
SimBu::plot_simulation(simulation = merged_simulations)
More features
Simulate using a whitelist (and blacklist) of cell-types
Sometimes, you are only interested in specific cell-types (for
example T cells), but the dataset you are using has too many other
cell-types; you can handle this issue during simulation using the
whitelist
parameter:
simulation <- SimBu::simulate_bulk(
data = ds,
scenario = "random",
scaling_factor = "NONE",
ncells = 1000,
nsamples = 20,
BPPARAM = BiocParallel::MulticoreParam(workers = 4),
run_parallel = TRUE,
whitelist = c("T cells CD4", "T cells CD8")
)
#> Using parallel generation of simulations.
#> Finished simulation.
SimBu::plot_simulation(simulation = simulation)
In the same way, you can also provide a blacklist
parameter, where you name the cell-types you don’t want
to be included in your simulation.
sessionInfo()
#> R version 4.3.1 (2023-06-16)
#> Platform: x86_64-pc-linux-gnu (64-bit)
#> Running under: Ubuntu 22.04.3 LTS
#>
#> Matrix products: default
#> BLAS: /usr/lib/x86_64-linux-gnu/openblas-pthread/libblas.so.3
#> LAPACK: /usr/lib/x86_64-linux-gnu/openblas-pthread/libopenblasp-r0.3.20.so; LAPACK version 3.10.0
#>
#> locale:
#> [1] LC_CTYPE=C.UTF-8 LC_NUMERIC=C LC_TIME=C.UTF-8
#> [4] LC_COLLATE=C.UTF-8 LC_MONETARY=C.UTF-8 LC_MESSAGES=C.UTF-8
#> [7] LC_PAPER=C.UTF-8 LC_NAME=C LC_ADDRESS=C
#> [10] LC_TELEPHONE=C LC_MEASUREMENT=C.UTF-8 LC_IDENTIFICATION=C
#>
#> time zone: UTC
#> tzcode source: system (glibc)
#>
#> attached base packages:
#> [1] stats graphics grDevices utils datasets methods base
#>
#> other attached packages:
#> [1] SimBu_1.5.0
#>
#> loaded via a namespace (and not attached):
#> [1] SummarizedExperiment_1.30.2 gtable_0.3.4
#> [3] ggplot2_3.4.4 xfun_0.40
#> [5] bslib_0.5.1 Biobase_2.60.0
#> [7] lattice_0.21-8 vctrs_0.6.4
#> [9] tools_4.3.1 bitops_1.0-7
#> [11] generics_0.1.3 stats4_4.3.1
#> [13] parallel_4.3.1 tibble_3.2.1
#> [15] fansi_1.0.5 pkgconfig_2.0.3
#> [17] Matrix_1.6-1.1 data.table_1.14.8
#> [19] RColorBrewer_1.1-3 desc_1.4.2
#> [21] S4Vectors_0.38.2 sparseMatrixStats_1.12.2
#> [23] RcppParallel_5.1.7 lifecycle_1.0.3
#> [25] GenomeInfoDbData_1.2.10 farver_2.1.1
#> [27] compiler_4.3.1 stringr_1.5.0
#> [29] textshaping_0.3.7 munsell_0.5.0
#> [31] codetools_0.2-19 GenomeInfoDb_1.36.4
#> [33] htmltools_0.5.6.1 sass_0.4.7
#> [35] RCurl_1.98-1.12 yaml_2.3.7
#> [37] pkgdown_2.0.7 pillar_1.9.0
#> [39] crayon_1.5.2 jquerylib_0.1.4
#> [41] tidyr_1.3.0 BiocParallel_1.34.2
#> [43] cachem_1.0.8 DelayedArray_0.26.7
#> [45] abind_1.4-5 tidyselect_1.2.0
#> [47] digest_0.6.33 stringi_1.7.12
#> [49] dplyr_1.1.3 purrr_1.0.2
#> [51] labeling_0.4.3 rprojroot_2.0.3
#> [53] fastmap_1.1.1 grid_4.3.1
#> [55] colorspace_2.1-0 cli_3.6.1
#> [57] magrittr_2.0.3 S4Arrays_1.0.6
#> [59] utf8_1.2.4 withr_2.5.1
#> [61] scales_1.2.1 rmarkdown_2.25
#> [63] XVector_0.40.0 matrixStats_1.0.0
#> [65] ragg_1.2.6 proxyC_0.3.4
#> [67] memoise_2.0.1 evaluate_0.22
#> [69] knitr_1.44 GenomicRanges_1.52.1
#> [71] IRanges_2.34.1 rlang_1.1.1
#> [73] Rcpp_1.0.11 glue_1.6.2
#> [75] BiocGenerics_0.46.0 jsonlite_1.8.7
#> [77] R6_2.5.1 MatrixGenerics_1.12.3
#> [79] systemfonts_1.0.5 fs_1.6.3
#> [81] zlibbioc_1.46.0