Browse code

Revise param description

Yuan authored on 13/01/2022 18:26:36
Showing 1 changed files

... ...
@@ -26,17 +26,17 @@
26 26
 #' should be considered different batches. Default NULL.
27 27
 #' @param background A numeric matrix of counts or a
28 28
 #' \linkS4class{SingleCellExperiment} with the matrix located in the assay
29
-#' slot under \code{assayName}. It should have the same structure as \code{x}
30
-#' except it contains the matrix of empty droplets instead of cells. When
31
-#' supplied, empirical distribution of transcripts from these empty droplets
29
+#' slot under \code{assayName}. It should have the same data format as \code{x}
30
+#' except it contains the empty droplets instead of cells. When supplied, 
31
+#' empirical distribution of transcripts from these empty droplets
32 32
 #' will be used as the contamination distribution. Default NULL.
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
+#' @param bgBatch Numeric or character vector. Batch labels for 
37
+#' \code{background}. Its unique values should be the same as those in
38
+#' \code{batch}, such that each batch of cells have their corresponding batch
39
+#' of empty droplets as background, pointed by this parameter. Default to NULL.
40 40
 #' @param maxIter Integer. Maximum iterations of the EM algorithm. Default 500.
41 41
 #' @param convergence Numeric. The EM algorithm will be stopped if the maximum
42 42
 #' difference in the contamination estimates between the previous and