Description Usage Arguments Details Value Methods (by class) Examples
Given an object with the data, it performs dimensionality reduction using a ZINB regression model with gene and cell-level covariates on a random subset of the data. It then projects the remaining data onto the lower dimensional space.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
Y |
The data (genes in rows, samples in columns). Currently implemented
only for |
... |
Additional parameters to describe the model, see
|
X |
The design matrix containing sample-level covariates, one sample per row. If missing, X will contain only an intercept. If Y is a SummarizedExperiment object, X can be a formula using the variables in the colData slot of Y. |
V |
The design matrix containing gene-level covariates, one gene per row. If missing, V will contain only an intercept. If Y is a SummarizedExperiment object, V can be a formula using the variables in the rowData slot of Y. |
K |
integer. Number of latent factors. Specify |
which_assay |
numeric or character. Which assay of Y to use. If missing, if 'assayNames(Y)' contains "counts" then that is used. Otherwise, the first assay is used. |
which_genes |
character. Which genes to use to estimate W (see details).
Ignored if |
zeroinflation |
Whether or not a ZINB model should be fitted. If FALSE, a negative binomial model is fitted instead. |
prop_fit |
numeric between 0 and 1. The proportion of cells to use for the zinbwave fit. |
BPPARAM |
object of class |
verbose |
Print helpful messages. |
This function implements an approximate strategy, in which the full
zinbwave
model is fit only on a random subset of the data
(controlled by the prop_fit
parameter). The rest of the samples are
subsequently projected onto the low-rank space. This strategy is much
faster and uses less memory than the full zinbwave
method. It
is recommended with extremely large datasets.
By default zinbsurf
uses all genes to estimate W
.
However, we recommend to use the top 1,000 most variable genes for this
step. In general, a user can specify any custom set of genes to be used to
estimate W
, by specifying either a vector of gene names, or a single
character string corresponding to a column of the rowData
.
An object of class SingleCellExperiment
; the dimensionality
reduced matrix is stored in the reducedDims
slot.
SummarizedExperiment
: Y is a
SummarizedExperiment
.
1 2 3 4 5 6 |
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.