FindSubCluster: Find subclusters under one cluster

Description Usage Arguments Value

View source: R/clustering.R

Description

Find subclusters under one cluster

Usage

1
2
3
4
5
6
7
8
FindSubCluster(
  object,
  cluster,
  graph.name,
  subcluster.name = "sub.cluster",
  resolution = 0.5,
  algorithm = 1
)

Arguments

object

An object

cluster

the cluster to be sub-clustered

graph.name

Name of graph to use for the clustering algorithm

subcluster.name

the name of sub cluster added in the meta.data

resolution

Value of the resolution parameter, use a value above (below) 1.0 if you want to obtain a larger (smaller) number of communities.

algorithm

Algorithm for modularity optimization (1 = original Louvain algorithm; 2 = Louvain algorithm with multilevel refinement; 3 = SLM algorithm; 4 = Leiden algorithm). Leiden requires the leidenalg python.

Value

return a object with sub cluster labels in the sub-cluster.name variable


ibseq/scs-analysis documentation built on Feb. 27, 2021, 12:35 a.m.