|
a |
|
b/man/getProfileNeighbors.Rd |
|
|
1 |
% Generated by roxygen2: do not edit by hand |
|
|
2 |
% Please edit documentation in R/clustering.R |
|
|
3 |
\name{getProfileNeighbors} |
|
|
4 |
\alias{getProfileNeighbors} |
|
|
5 |
\title{Get profile specific neighbors} |
|
|
6 |
\usage{ |
|
|
7 |
getProfileNeighbors( |
|
|
8 |
object, |
|
|
9 |
assay = NULL, |
|
|
10 |
method = "kNN", |
|
|
11 |
k = 10, |
|
|
12 |
data.type = "pca", |
|
|
13 |
dims = seq_len(30), |
|
|
14 |
graph.key = method |
|
|
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{method}{the method used for graph construction, SNN or kNN} |
|
|
24 |
|
|
|
25 |
\item{k}{number of neighbors for kNN} |
|
|
26 |
|
|
|
27 |
\item{data.type}{the type of embedding used for neighborhood calculation, e.g. raw counts (raw), normalized counts (norm), PCA embeddings (pca), UMAP embeddings (umap) etc.} |
|
|
28 |
|
|
|
29 |
\item{dims}{the set of dimensions of the embedding data} |
|
|
30 |
|
|
|
31 |
\item{graph.key}{the name of the graph} |
|
|
32 |
} |
|
|
33 |
\description{ |
|
|
34 |
Get neighbors of spatial points |
|
|
35 |
} |