File: umify.Rd

package info (click to toggle)
r-cran-sctransform 0.4.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 600 kB
  • sloc: cpp: 323; sh: 13; makefile: 2
file content (38 lines) | stat: -rw-r--r-- 1,258 bytes parent folder | download | duplicates (2)
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/umify.R
\name{umify}
\alias{umify}
\title{Quantile normalization of cell-level data to match typical UMI count data}
\usage{
umify(counts)
}
\arguments{
\item{counts}{A matrix of class dgCMatrix with genes as rows and columns as cells}
}
\value{
A UMI-fied count matrix
}
\description{
Quantile normalization of cell-level data to match typical UMI count data
}
\section{Details}{

sctransform::vst operates under the assumption that gene counts approximately 
follow a Negative Binomial dristribution. For UMI-based data that seems to be 
the case, however, non-UMI data does not behave in the same way. 
In some cases it might be better to to apply a transformation to such data 
to make it look like UMI data. This function applies such a transformation function.

Cells in the input matrix are processed independently. For each cell
the non-zero data is transformed to quantile values. Based on the number of genes 
detected a smooth function is used to predict the UMI-like counts.

The functions have be trained on various public data sets and come as part of the 
package (see umify_data data set in this package).
}

\examples{
\donttest{
silly_example <- umify(pbmc)
}
}