1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/denoise.R
\name{correct_counts}
\alias{correct_counts}
\title{Correct data by setting all latent factors to their median values and reversing the regression model}
\usage{
correct_counts(
x,
umi,
cell_attr = x$cell_attr,
scale_factor = NA,
verbosity = 2,
verbose = NULL,
show_progress = NULL
)
}
\arguments{
\item{x}{A list that provides model parameters and optionally meta data; use output of vst function}
\item{umi}{The count matrix}
\item{cell_attr}{Provide cell meta data holding latent data info}
\item{scale_factor}{Replace all values of UMI in the regression model by this value. Default is NA
which uses median of total UMI as the latent factor.}
\item{verbosity}{An integer specifying whether to show only messages (1), messages and progress bars (2) or nothing (0) while the function is running; default is 2}
\item{verbose}{Deprecated; use verbosity instead}
\item{show_progress}{Deprecated; use verbosity instead}
}
\value{
Corrected data as UMI counts
}
\description{
This version does not need a matrix of Pearson residuals. It takes the count matrix as input and
calculates the residuals on the fly. The corrected UMI counts will be rounded to the nearest
integer and negative values clipped to 0.
}
\examples{
\donttest{
vst_out <- vst(pbmc, return_cell_attr = TRUE)
umi_corrected <- correct_counts(vst_out, pbmc)
}
}
|
