runCxds: Find doublets/multiplets using cxds.

Description Usage Arguments Value Examples

View source: R/scds_doubletdetection.R

Description

A wrapper function for cxds. Annotate doublets/multiplets using co-expression based approach. Generate a doublet score for each cell. Infer doublets if estNdbl is TRUE.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
runCxds(
  inSCE,
  sample = NULL,
  seed = 12345,
  ntop = 500,
  binThresh = 0,
  verb = FALSE,
  retRes = FALSE,
  estNdbl = FALSE,
  useAssay = "counts"
)

Arguments

inSCE

A SingleCellExperiment object. Needs counts in assays slot.

sample

Character vector. Indicates which sample each cell belongs to. cxds will be run on cells from each sample separately. If NULL, then all cells will be processed together. Default NULL.

seed

Seed for the random number generator. Default 12345.

ntop

See cxds for more information. Default 500.

binThresh

See cxds for more information. Default 0.

verb

See cxds for more information. Default FALSE.

retRes

See cxds for more information. Default FALSE.

estNdbl

See cxds for more information. Default FALSE.

useAssay

A string specifying which assay in the SCE to use.

Value

A SingleCellExperiment object with cxds output appended to the colData slot. The columns include cxds_score and optionally cxds_call. Please refer to the documentation of cxds for details.

Examples

1
2
3
data(scExample, package = "singleCellTK")
sce <- subsetSCECols(sce, colData = "type != 'EmptyDroplet'")
sce <- runCxds(sce)

singleCellTK documentation built on Nov. 8, 2020, 5:21 p.m.