[413088]: / man / getUMAP.Rd

Download this file

36 lines (29 with data), 903 Bytes

 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/processing.R
\name{getUMAP}
\alias{getUMAP}
\title{getUMAP}
\usage{
getUMAP(
object,
assay = NULL,
data.type = "pca",
dims = seq_len(30),
umap.key = "umap",
overwrite = FALSE,
seed = 1
)
}
\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{data.type}{the type of data used to calculate UMAP from: "pca" (default), "raw" or "norm"}
\item{dims}{the number of dimensions extracted from PCA}
\item{umap.key}{the name of the umap embedding, default: umap}
\item{overwrite}{Whether the existing embedding with name 'type' should be overwritten in \link{vrEmbeddings}}
\item{seed}{seed}
}
\description{
calculate UMAP of the VoltRon objects
}