Browse code

Updated plotCellMiner2D documentation

cannin authored on 27/02/2017 17:21:31
Showing 2 changed files

... ...
@@ -11,7 +11,7 @@
11 11
 #' @param showLegend boolean, whether to show the legend (DEFAULT: FALSE)
12 12
 #' @param showTrendLine boolean, whether to show the trendline 
13 13
 #' @param showTitle boolean, whether to show the title
14
-#' @param alpha value from 0-1, where 0 indicates transparent points
14
+#' @param alpha value from 0-1, where 0 indicates transparent points (DEFAULT: 1, not transparent)
15 15
 #' @param numberColPrefix a prefix to add to column names that start with a number that causes issues with ggplot (DEFAULT: X)
16 16
 #' 
17 17
 #' @return a ggplot object
... ...
@@ -32,7 +32,7 @@ plotCellMiner2D(df, xCol = "x", yCol = "y", xLabel = xCol,
32 32
 
33 33
 \item{showTitle}{boolean, whether to show the title}
34 34
 
35
-\item{alpha}{value from 0-1, where 0 indicates transparent points}
35
+\item{alpha}{value from 0-1, where 0 indicates transparent points (DEFAULT: 1, not transparent)}
36 36
 
37 37
 \item{numberColPrefix}{a prefix to add to column names that start with a number that causes issues with ggplot (DEFAULT: X)}
38 38
 }