R语言Seurat包 RunUMAP函数使用说明
功能\作用概述:
运行统一流形近似和投影(UMAP)降维技术。要运行,必须首先安装umap learn pythonpackage(例如,通过pip install umap learn)。
语法\用法:
RunUMAP(object, ...)
Default S3 method:
RunUMAP(
object,
reduction.key = "UMAP_",
assay = NULL,
reduction.model = NULL,
return.model = FALSE,
umap.method = "uwot",
n.neighbors = 30L,
n.components = 2L,
metric = "cosine",
n.epochs = NULL,
learning.rate = 1,
min.dist = 0.3,
spread = 1,
set.op.mix.ratio = 1,
local.connectivity = 1L,
repulsion.strength = 1,
negative.sample.rate = 5,
a = NULL,
b = NULL,
uwot.sgd = FALSE,
seed.use = 42,
metric.kwds = NULL,
angular.rp.forest = FALSE,
verbose = TRUE,
...
)
S3 method for class 'Graph'
RunUMAP(
object,
assay = NULL,
umap.method = "umap-learn",
n.components = 2L,
metric = "correlation",
n.epochs = 0L,
learning.rate = 1,
min.dist = 0.3,
spread = 1,
repulsion.strength = 1,
negative.sample.rate = 5L,
a = NULL,
b = NULL,
uwot.sgd = FALSE,
seed.use = 42L,
metric.kwds = NULL,
verbose = TRUE,
reduction.key = "UMAP_",
...
)
S3 method for class 'Seurat'
RunUMAP(
object,
dims = NULL,
reduction = "pca",
features = NULL,
graph = NULL,
assay = DefaultAssay(object = object),
nn.name = NULL,
slot = "data",
umap.method = "uwot",
reduction.model = NULL,
return.model = FALSE,
n.neighbors = 30L,
n.components = 2L,
metric = "cosine",
n.epochs = NULL,
learning.rate = 1,
min.dist = 0.3,
spread = 1,
set.op.mix.ratio = 1,
local.connectivity = 1L,
repulsion.strength = 1,
negative.sample.rate = 5L,
a = NULL,
b = NULL,
uwot.sgd = FALSE,
seed.use = 42L,
metric.kwds = NULL,
angular.rp.forest = FALSE,
verbose = TRUE,
reduction.name = "umap",
reduction.key = "UMAP_",
...
)
参数说明:
object : 一个物体
... : 传递给其他方法和UMAP的参数
reduction.key : 维度缩减键,指定维度名称的数字之前的字符串。默认情况下为UMAP
assay : 使用功能时提取数据的分析,或用于在图形上运行UMAP构建图形的分析
reduction.model : 包含umap模型的DimReduc对象
return.model : UMAP是否返回uwot模型
umap.method : 要运行的UMAP实现。可以贝乌:运行umap通过uwot R packageuwot-学习:运行umap通过uwot R包并返回学习的umap modelumap-学习:运行python umap学习包的Seurat包装器
n.neighbors : 这决定了在流形结构的局部近似中使用的相邻点的数量。较大的值将导致在丢失详细的局部结构的情况下保留更多的全局结构。一般来说,此参数通常应在5到50之间。
n.components : 要嵌入的空间的尺寸。
metric : 度量:这决定了用于度量输入空间中的距离的度量的选择。已经对各种各样的度量进行了编码,并且只要numba对用户定义的函数进行了JITd,就可以传递它。
n.epochs : 用于优化低维嵌入的训练次数。值越大,嵌入越精确。如果指定NULL,则将根据输入数据集的大小选择一个值(大数据集为200,小数据集为500)。
learning.rate : 嵌入优化的初始学习率。
min.dist : 这将控制允许嵌入压缩点的程度一起。大一点值确保嵌入点分布更均匀,而较小的值允许算法更精确地优化局部结构。敏感值在0.001到0.5之间。
spread : 嵌入点的有效比例。结合最小距离这将确定嵌入点的聚集/聚集方式。
set.op.mix.ratio : 在(fuzzy)并集和交集之间插值作为集合运算,用于组合局部fuzzy单形集以获得全局fuzzy单形集。两个fuzzyset操作都使用乘积t-范数。此参数的值应介于0.0和1.0之间;值1.0将使用纯模糊并集,而0.0将使用纯模糊交集。
local.connectivity : 所需的本地连接性-即应假定在本地级别连接的最近邻居的数量。此值越高,则歧管的局部连接就越多。实际上,这不应超过歧管的局部内部尺寸。
repulsion.strength : 低维嵌入优化中负样本的加权。大于1的值将导致负数的权重更大。
negative.sample.rate : 优化过程中每个阳性样本要选择的阴性样本数。增加该值将导致应用更大的斥力、更大的优化成本,但精度略高。
a : 更具体的参数控制嵌入。如果为空,则根据最小距离和排列自动设置这些值。右伴随函子可微逼近的参数。
b : 更具体的参数控制嵌入。如果为空,则根据最小距离和排列自动设置这些值。右伴随函子可微逼近的参数。
uwot.sgd : 设置uwot::umap(ca/pls/public/gscw031+9999995owa_no_site=314+99999owa_no_fiche=3+99999owa_bottin==TRUE);有关详细信息,请参见umap
seed.use : 设置随机种子。默认情况下,将种子设置为42。SettingNULL不会设置种子
metric.kwds : 传递到度量的参数字典,例如p值forMinkowski距离。如果为NULL,则不传递任何参数。
angular.rp.forest : 是否使用角度随机投影林来初始化近似最近邻搜索。这可能会更快,但对于使用角度样式距离(如余弦、相关性等)的度量,它最有用。在这些度量的情况下,将自动选择角度林。
verbose : 控制冗长
dims : 哪些维度用作输入特征,仅用于iFeatures为空
reduction : 要用于umap输入的降维(PCA或ICA)。默认值为PCA
features : 如果已设置,则在该特征子集上运行UMAP(而不是在缩减的维度集上运行)。默认情况下不设置(NULL);dims必须为NULL才能运行特征
graph : 要在其上运行UMAP的图形的名称
nn.name : 运行UMAP的knn输出的名称
slot : 使用功能时用于提取数据的插槽。默认情况下,数据槽为。
reduction.name : 在Seurat对象中存储维度缩减的名称
示例\实例:
Not run:
pbmc_small
Run UMAP map on first 5 PCs
pbmc_small < - RunUMAP(object = pbmc_small, dims = 1:5)
Plot results
DimPlot(object = pbmc_small, reduction = 'umap')