--- a +++ b/man/getHotSpotAnalysis.Rd @@ -0,0 +1,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 +}