Browse code

Adding bgBatch description

Yuan authored on 13/01/2022 05:16:34
Showing 1 changed files

... ...
@@ -33,6 +33,10 @@
33 33
 #' @param bgAssayName Character. Name of the assay to use if \code{background}
34 34
 #' is a \linkS4class{SingleCellExperiment}. Default to same as
35 35
 #' \code{assayName}.
36
+#' @param bgBatch Numeric or chracter vector. Batch labels for 
37
+#' \code{background}. Its unique values should be the same as in \code{batch},
38
+#' such that each batch of cells have their corresponding background batch.
39
+#' Default to NULL.
36 40
 #' @param maxIter Integer. Maximum iterations of the EM algorithm. Default 500.
37 41
 #' @param convergence Numeric. The EM algorithm will be stopped if the maximum
38 42
 #' difference in the contamination estimates between the previous and