R/runBatchCorrection.R
runBBKNN.Rd
BBKNN, an extremely fast graph-based data integration algorithm. It modifies the neighbourhood construction step to produce a graph that is balanced across all batches of the data.
runBBKNN(
inSCE,
useAssay = "logcounts",
batch = "batch",
reducedDimName = "BBKNN",
nComponents = 50L
)
SingleCellExperiment inherited object. Required.
A single character indicating the name of the assay requiring
batch correction. Default "logcounts"
.
A single character indicating a field in
colData
that annotates the batches.
Default "batch"
.
A single character. The name for the corrected
low-dimensional representation. Will be saved to reducedDim(inSCE)
.
Default "BBKNN"
.
An integer. Number of principle components or the
dimensionality, adopted in the pre-PCA-computation step, the BBKNN step (for
how many PCs the algorithm takes into account), and the final UMAP
combination step where the value represent the dimensionality of the updated
reducedDim. Default 50L
.
The input SingleCellExperiment object with
reducedDim(inSCE, reducedDimName)
updated.
Krzysztof Polanski et al., 2020