|
a |
|
b/man/Normalizedata.Rd |
|
|
1 |
% Generated by roxygen2: do not edit by hand |
|
|
2 |
% Please edit documentation in R/DIscBIO-generic-Normalizedata.R |
|
|
3 |
\name{Normalizedata} |
|
|
4 |
\alias{Normalizedata} |
|
|
5 |
\alias{Normalizedata,DISCBIO-method} |
|
|
6 |
\title{Normalizing and filtering} |
|
|
7 |
\usage{ |
|
|
8 |
Normalizedata( |
|
|
9 |
object, |
|
|
10 |
mintotal = 1000, |
|
|
11 |
minexpr = 0, |
|
|
12 |
minnumber = 0, |
|
|
13 |
maxexpr = Inf, |
|
|
14 |
downsample = FALSE, |
|
|
15 |
dsn = 1, |
|
|
16 |
rseed = NULL |
|
|
17 |
) |
|
|
18 |
|
|
|
19 |
\S4method{Normalizedata}{DISCBIO}( |
|
|
20 |
object, |
|
|
21 |
mintotal = 1000, |
|
|
22 |
minexpr = 0, |
|
|
23 |
minnumber = 0, |
|
|
24 |
maxexpr = Inf, |
|
|
25 |
downsample = FALSE, |
|
|
26 |
dsn = 1, |
|
|
27 |
rseed = NULL |
|
|
28 |
) |
|
|
29 |
} |
|
|
30 |
\arguments{ |
|
|
31 |
\item{object}{\code{DISCBIO} class object.} |
|
|
32 |
|
|
|
33 |
\item{mintotal}{minimum total transcript number required. Cells with less |
|
|
34 |
than \code{mintotal} transcripts are filtered out. Default is 1000.} |
|
|
35 |
|
|
|
36 |
\item{minexpr}{minimum required transcript count of a gene in at least |
|
|
37 |
\code{minnumber} cells. All other genes are filtered out. Default is 0.} |
|
|
38 |
|
|
|
39 |
\item{minnumber}{minimum number of cells that are expressing each gene at |
|
|
40 |
minexpr transcripts. Default is 0.} |
|
|
41 |
|
|
|
42 |
\item{maxexpr}{maximum allowed transcript count of a gene in at least a |
|
|
43 |
single cell after normalization or downsampling. All other genes are |
|
|
44 |
filtered out. Default is Inf.} |
|
|
45 |
|
|
|
46 |
\item{downsample}{A logical vector. Default is FALSE. If downsample is set to |
|
|
47 |
TRUE, then transcript counts are downsampled to mintotal transcripts per |
|
|
48 |
cell, instead of the normalization. Downsampled versions of the transcript |
|
|
49 |
count data are averaged across dsn samples} |
|
|
50 |
|
|
|
51 |
\item{dsn}{A numeric value of the number of samples to be used to average the |
|
|
52 |
downsampled versions of the transcript count data. Default is 1 which means |
|
|
53 |
that sampling noise should be comparable across cells. For high numbers of |
|
|
54 |
dsn the data will become similar to the median normalization.} |
|
|
55 |
|
|
|
56 |
\item{rseed}{Random integer to enforce reproducible clustering. |
|
|
57 |
results} |
|
|
58 |
} |
|
|
59 |
\value{ |
|
|
60 |
The DISCBIO-class object input with the ndata and fdata slots filled. |
|
|
61 |
} |
|
|
62 |
\description{ |
|
|
63 |
This function allows filtering of genes and cells to be used in |
|
|
64 |
the downstream analysis. |
|
|
65 |
} |
|
|
66 |
\examples{ |
|
|
67 |
sc <- DISCBIO(valuesG1msTest) # changes signature of data |
|
|
68 |
|
|
|
69 |
# In this case this function is used to normalize the reads |
|
|
70 |
sc_normal <- Normalizedata( |
|
|
71 |
sc, |
|
|
72 |
mintotal = 1000, minexpr = 0, minnumber = 0, maxexpr = Inf, |
|
|
73 |
downsample = FALSE, dsn = 1, rseed = 17000 |
|
|
74 |
) |
|
|
75 |
summary(sc_normal@fdata) |
|
|
76 |
|
|
|
77 |
} |