|
a |
|
b/man/vrNeighbourhoodEnrichment.Rd |
|
|
1 |
% Generated by roxygen2: do not edit by hand |
|
|
2 |
% Please edit documentation in R/spatial.R |
|
|
3 |
\name{vrNeighbourhoodEnrichment} |
|
|
4 |
\alias{vrNeighbourhoodEnrichment} |
|
|
5 |
\title{vrNeighbourhoodEnrichment} |
|
|
6 |
\usage{ |
|
|
7 |
vrNeighbourhoodEnrichment( |
|
|
8 |
object, |
|
|
9 |
assay = NULL, |
|
|
10 |
group.by = NULL, |
|
|
11 |
graph.type = "delaunay", |
|
|
12 |
num.sim = 1000, |
|
|
13 |
seed = 1, |
|
|
14 |
verbose = TRUE |
|
|
15 |
) |
|
|
16 |
} |
|
|
17 |
\arguments{ |
|
|
18 |
\item{object}{a VoltRon object} |
|
|
19 |
|
|
|
20 |
\item{assay}{assay name (exp: Assay1) or assay class (exp: Visium, Xenium), see \link{SampleMetadata}. |
|
|
21 |
if NULL, the default assay will be used, see \link{vrMainAssay}.} |
|
|
22 |
|
|
|
23 |
\item{group.by}{a column from metadata to seperate spatial points} |
|
|
24 |
|
|
|
25 |
\item{graph.type}{the type of graph to determine spatial neighborhood} |
|
|
26 |
|
|
|
27 |
\item{num.sim}{the number of simulations} |
|
|
28 |
|
|
|
29 |
\item{seed}{seed} |
|
|
30 |
|
|
|
31 |
\item{verbose}{verbose} |
|
|
32 |
} |
|
|
33 |
\description{ |
|
|
34 |
Conduct Neighborhood enrichment test for pairs of clusters for all assays |
|
|
35 |
} |