diff options
| author | Xin Ren <iamshrek@126.com> | 2016-08-10 00:49:06 -0700 |
|---|---|---|
| committer | Felix Cheung <felixcheung@apache.org> | 2016-08-10 00:49:06 -0700 |
| commit | 1203c8415cd11540f79a235e66a2f241ca6c71e4 (patch) | |
| tree | 7572361ee2e22a7d948484b2dccb2f10d682e18f /R | |
| parent | 9dc3e602d77ccdf670f1b6648e5674066d189cc0 (diff) | |
| download | spark-1203c8415cd11540f79a235e66a2f241ca6c71e4.tar.gz spark-1203c8415cd11540f79a235e66a2f241ca6c71e4.tar.bz2 spark-1203c8415cd11540f79a235e66a2f241ca6c71e4.zip | |
[MINOR][SPARKR] R API documentation for "coltypes" is confusing
## What changes were proposed in this pull request?
R API documentation for "coltypes" is confusing, found when working on another ticket.
Current version http://spark.apache.org/docs/2.0.0/api/R/coltypes.html, where parameters have 2 "x" which is a duplicate, and also the example is not very clear
## How was this patch tested?
Tested manually on local machine. And the screenshots are like below:
Author: Xin Ren <iamshrek@126.com>
Closes #14489 from keypointt/rExample.
Diffstat (limited to 'R')
| -rw-r--r-- | R/pkg/R/DataFrame.R | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/R/pkg/R/DataFrame.R b/R/pkg/R/DataFrame.R index a4733313ed..0ce4696198 100644 --- a/R/pkg/R/DataFrame.R +++ b/R/pkg/R/DataFrame.R @@ -223,7 +223,7 @@ setMethod("showDF", #' sparkR.session() #' path <- "path/to/file.json" #' df <- read.json(path) -#' df +#' show(df) #'} #' @note show(SparkDataFrame) since 1.4.0 setMethod("show", "SparkDataFrame", @@ -368,7 +368,7 @@ setMethod("colnames<-", #' @examples #'\dontrun{ #' irisDF <- createDataFrame(iris) -#' coltypes(irisDF) +#' coltypes(irisDF) # get column types #'} #' @note coltypes since 1.6.0 setMethod("coltypes", @@ -411,7 +411,6 @@ setMethod("coltypes", #' #' Set the column types of a SparkDataFrame. #' -#' @param x A SparkDataFrame #' @param value A character vector with the target column types for the given #' SparkDataFrame. Column types can be one of integer, numeric/double, character, logical, or NA #' to keep that column as-is. @@ -424,8 +423,8 @@ setMethod("coltypes", #' sparkR.session() #' path <- "path/to/file.json" #' df <- read.json(path) -#' coltypes(df) <- c("character", "integer") -#' coltypes(df) <- c(NA, "numeric") +#' coltypes(df) <- c("character", "integer") # set column types +#' coltypes(df) <- c(NA, "numeric") # set column types #'} #' @note coltypes<- since 1.6.0 setMethod("coltypes<-", |