Browse code

update doc

zhewa authored on 16/10/2020 14:44:07
Showing 2 changed files

... ...
@@ -802,7 +802,10 @@ setMethod("plotDimReduceModule",
802 802
 #' @description Create a scatterplot for each row of a normalized
803 803
 #'  gene expression matrix where x and y axis are from a
804 804
 #'  data dimension reduction tool.
805
-#'  The cells are colored by its given \code{cluster} label.
805
+#'  The cells are colored by "celda_cell_cluster" column in
806
+#'   \code{colData(altExp(x, altExpName))} if \code{x} is a
807
+#'   \linkS4class{SingleCellExperiment} object, or \code{x} if \code{x} is
808
+#'   a integer vector of cell cluster labels.
806 809
 #' @param x Integer vector of cell cluster labels or a
807 810
 #'  \linkS4class{SingleCellExperiment} object
808 811
 #'  containing cluster labels for each cell in \code{"celda_cell_cluster"}
... ...
@@ -85,7 +85,10 @@ The plot as a ggplot object
85 85
 Create a scatterplot for each row of a normalized
86 86
  gene expression matrix where x and y axis are from a
87 87
  data dimension reduction tool.
88
- The cells are colored by its given \code{cluster} label.
88
+ The cells are colored by "celda_cell_cluster" column in
89
+  \code{colData(altExp(x, altExpName))} if \code{x} is a
90
+  \linkS4class{SingleCellExperiment} object, or \code{x} if \code{x} is
91
+  a integer vector of cell cluster labels.
89 92
 }
90 93
 \examples{
91 94
 data(sceCeldaCG)