getCellPairs {scDblFinder} | R Documentation

## getCellPairs

### Description

Given a vector of cluster labels, returns pairs of cross-cluster cells

### Usage

    getCellPairs(
      clusters,
      n = 1000,
      ls = NULL,
      q = c(0.1, 0.9),
      selMode = "proportional",
      soft.min = 5
    )

### Arguments

`clusters` | A vector of cluster labels for each cell, or a list containing metacells and graph
`n` | The number of cell pairs to obtain
`ls` | Optional library sizes
`q` | Library size quantiles between which to include cells (ignored if 'ls' is NULL)
`selMode` | How to decide the number of pairs of each kind to produce. Either 'proportional' (default, proportional to the abundance of the underlying clusters), 'uniform' or 'sqrt'.
`soft.min` | Minimum number of pairs of a given type.

### Value

A data.frame with the columns

### Examples

    # create random labels
    x <- sample(head(LETTERS), 100, replace=TRUE)
    getCellPairs(x, n=6)

[Package scDblFinder version 1.8.0 Index]