ListClusterGroups: List Cluster Groups

In ZJUDBlab/InterCellDB: Tool and Database for Analyzing Interactions

List Cluster Groups

Description

This function is to help on listing all or some of cluster groups (i.e. interacting clusters).

Usage

ListClusterGroups(
  object,
  use.former = FALSE,
  cluster.former = character(),
  use.latter = FALSE,
  cluster.latter = character()
)

Arguments

object	A InterCell object, which is created by CreateInterCellObject.
use.former	It controls whether to list cluster groups relating to one or some clusters(.X) given in parameter sel.clusters.X of link{AnalyzeInterInFullView}.
cluster.former	The name of clusters, which is used find all X~? interactions (X is cluters given in these parameter).
use.latter	It controls whether to list cluster groups relating to one or some clusters(.Y) given in parameter sel.clusters.Y of link{AnalyzeInterInFullView}.
cluster.latter	The name of clusters, which is used find all ?~Y interactions (Y is cluters given in these parameter).

Value

Character. Names of cluster groups.

Examples

## Not run: 
 ListClusterGroups(object, use.former = TRUE, cluster.former = "T_cell")
 # the output of this will be "T_cell~Macrophage", "T_cell~B_cell" and things like that, depending on available clusters.

 ListClusterGroups(object, use.latter = TRUE, cluster.latter = "T_cell")
 # the output of this will be "Macrophage~T_cell", "B_cell~T_cell" and things like that, depending on available clusters.

## End(Not run)

ZJUDBlab/InterCellDB documentation built on March 19, 2023, 4:56 p.m.