Diff of /man/normalizeData.Rd [000000] .. [413088]

Switch to unified view

a b/man/normalizeData.Rd
1
% Generated by roxygen2: do not edit by hand
2
% Please edit documentation in R/allgenerics.R, R/processing.R
3
\name{normalizeData}
4
\alias{normalizeData}
5
\alias{normalizeData,VoltRon-method}
6
\alias{normalizeData,vrAssay-method}
7
\alias{normalizeData,vrAssayV2-method}
8
\title{Normalize Data}
9
\usage{
10
normalizeData(object, ...)
11
12
\S4method{normalizeData}{VoltRon}(
13
  object,
14
  assay = NULL,
15
  method = "LogNorm",
16
  desiredQuantile = 0.9,
17
  scale = 0.2,
18
  sizefactor = 10000,
19
  feat_type = NULL
20
)
21
22
\S4method{normalizeData}{vrAssay}(
23
  object,
24
  method = "LogNorm",
25
  desiredQuantile = 0.9,
26
  scale = 0.2,
27
  sizefactor = 10000,
28
  feat_type = NULL
29
)
30
31
\S4method{normalizeData}{vrAssayV2}(
32
  object,
33
  method = "LogNorm",
34
  desiredQuantile = 0.9,
35
  scale = 0.2,
36
  sizefactor = 10000,
37
  feat_type = NULL
38
)
39
}
40
\arguments{
41
\item{object}{a VoltRon or vrAssay object.}
42
43
\item{...}{arguments passed to other methods.}
44
45
\item{assay}{assay name (exp: Assay1) or assay class (exp: Visium, Xenium), see \link{SampleMetadata}. 
46
if NULL, the default assay will be used, see \link{vrMainAssay}.}
47
48
\item{method}{the normalization method: "LogNorm", "Q3Norm", "LogQ3Norm" or "CLR"}
49
50
\item{desiredQuantile}{the quantile of the data if "QuanNorm" or "LogQuanNorm" is selected as \code{method}.}
51
52
\item{scale}{the scale parameter for the hyperbolic arcsine transformation}
53
54
\item{sizefactor}{size factor if \code{method} is selected as \code{LogNorm}}
55
56
\item{feat_type}{the feature set type}
57
}
58
\description{
59
Given a VoltRon or vrAssay object, normalize the raw count data.
60
}