forked from ScreachingFire/DoubletFinderClone
-
Notifications
You must be signed in to change notification settings - Fork 0
/
modelHomotypic.Rd
40 lines (37 loc) · 1.31 KB
/
modelHomotypic.Rd
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
\name{modelHomotypic}
\alias{modelHomotypic}
\title{modelHomotypic}
\description{
Leverages user-provided cell annotations to model the proportion of homotypic doublets. Building on the assumption that literature-supported annotations reflect real transcriptional divergence, homotypic doublet proportions are modeled as the sum of squared annotation frequencies.
}
\usage{modelHomotypic(annotations)}
%- maybe also 'usage' for other objects documented here.
\arguments{
\item{annotations}{ An nCell-length character vector of annotations.
}
}
\details{
}
\value{ Numeric proportion of homotypic doublets. }
\references{
%% ~put references to the literature/web site here ~
}
\author{
%% ~~who you are~~
}
\note{
%% ~~further notes~~
}
%% ~Make other sections like Warning with \section{Warning }{....} ~
\seealso{
%% ~~objects to See Also as \code{\link{help}}, ~~~
}
\examples{
## Initial run, nExp set to Poisson loading estimate (e.g., 913 total doublet predictions)
nExp_poi <- round(0.15*length([email protected]))
seu <- doubletFinder(seu, pN = 0.25, pK = 0.01, nExp = nExp_poi, reuse.pANN = FALSE)
## With homotypic adjustment
homotypic.prop <- modelHomotypic(annotations)
nExp_poi.adj <- round(nExp_poi*(1-homotypic.prop))
seu <- doubletFinder(seu, pN = 0.25, pK = 0.01, nExp = nExp_poi.adj, reuse.pANN = "pANN_0.25_0.01_913")
}