[413088]: / man / getHotSpotAnalysis.Rd

Download this file

39 lines (31 with data), 1.1 kB

 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/spatial.R
\name{getHotSpotAnalysis}
\alias{getHotSpotAnalysis}
\title{getHotSpotAnalysis}
\usage{
getHotSpotAnalysis(
object,
assay = NULL,
method = "Getis-Ord",
features,
graph.type = "delaunay",
alpha.value = 0.01,
norm = TRUE,
verbose = TRUE
)
}
\arguments{
\item{object}{a VoltRon object}
\item{assay}{assay name (exp: Assay1) or assay class (exp: Visium, Xenium), see \link{SampleMetadata}.
if NULL, the default assay will be used, see \link{vrMainAssay}.}
\item{method}{the statistical method of conducting hot spot analysis. Default is "Getis-Ord"}
\item{features}{a set of features to be visualized, either from \link{vrFeatures} of raw or normalized data or columns of the \link{Metadata}.}
\item{graph.type}{the type of graph to determine spatial neighborhood}
\item{alpha.value}{the alpha value for the hot spot analysis test. Default is 0.01}
\item{norm}{if TRUE, the normalized data is used}
\item{verbose}{verbose}
}
\description{
Conduct hot spot detection
}