Repository: spark Updated Branches: refs/heads/master 2d90c04f2 -> 7f203a248
[SPARKR] Fix bad examples in DataFrame methods and style issues ## What changes were proposed in this pull request? Some examples in the DataFrame methods are syntactically wrong, even though they are pseudo code. Fix these and some style issues. Author: Wayne Zhang <actuaryzh...@uber.com> Closes #18003 from actuaryzhang/sparkRDoc3. Project: http://git-wip-us.apache.org/repos/asf/spark/repo Commit: http://git-wip-us.apache.org/repos/asf/spark/commit/7f203a24 Tree: http://git-wip-us.apache.org/repos/asf/spark/tree/7f203a24 Diff: http://git-wip-us.apache.org/repos/asf/spark/diff/7f203a24 Branch: refs/heads/master Commit: 7f203a248f94df6183a4bc4642a3d873171fef29 Parents: 2d90c04 Author: Wayne Zhang <actuaryzh...@uber.com> Authored: Fri May 19 11:18:20 2017 -0700 Committer: Felix Cheung <felixche...@apache.org> Committed: Fri May 19 11:18:20 2017 -0700 ---------------------------------------------------------------------- R/pkg/R/DataFrame.R | 14 +++++++------ R/pkg/R/WindowSpec.R | 3 ++- R/pkg/R/column.R | 6 ++++-- R/pkg/R/functions.R | 51 +++++++++++++++++++++++++++++++---------------- 4 files changed, 48 insertions(+), 26 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/spark/blob/7f203a24/R/pkg/R/DataFrame.R ---------------------------------------------------------------------- diff --git a/R/pkg/R/DataFrame.R b/R/pkg/R/DataFrame.R index 2b5888f..166b398 100644 --- a/R/pkg/R/DataFrame.R +++ b/R/pkg/R/DataFrame.R @@ -549,7 +549,7 @@ setMethod("registerTempTable", #' sparkR.session() #' df <- read.df(path, "parquet") #' df2 <- read.df(path2, "parquet") -#' createOrReplaceTempView(df, "table1") +#' saveAsTable(df, "table1") #' insertInto(df2, "table1", overwrite = TRUE) #'} #' @note insertInto since 1.4.0 @@ -1125,7 +1125,8 @@ setMethod("dim", #' path <- "path/to/file.json" #' df <- read.json(path) #' collected <- collect(df) -#' firstName <- collected[[1]]$name +#' class(collected) +#' firstName <- names(collected)[1] #' } #' @note collect since 1.4.0 setMethod("collect", @@ -2814,7 +2815,7 @@ setMethod("except", #' path <- "path/to/file.json" #' df <- read.json(path) #' write.df(df, "myfile", "parquet", "overwrite") -#' saveDF(df, parquetPath2, "parquet", mode = saveMode, mergeSchema = mergeSchema) +#' saveDF(df, parquetPath2, "parquet", mode = "append", mergeSchema = TRUE) #' } #' @note write.df since 1.4.0 setMethod("write.df", @@ -3097,8 +3098,8 @@ setMethod("fillna", #' @family SparkDataFrame functions #' @aliases as.data.frame,SparkDataFrame-method #' @rdname as.data.frame -#' @examples \dontrun{ -#' +#' @examples +#' \dontrun{ #' irisDF <- createDataFrame(iris) #' df <- as.data.frame(irisDF[irisDF$Species == "setosa", ]) #' } @@ -3175,7 +3176,8 @@ setMethod("with", #' @aliases str,SparkDataFrame-method #' @family SparkDataFrame functions #' @param object a SparkDataFrame -#' @examples \dontrun{ +#' @examples +#' \dontrun{ #' # Create a SparkDataFrame from the Iris dataset #' irisDF <- createDataFrame(iris) #' http://git-wip-us.apache.org/repos/asf/spark/blob/7f203a24/R/pkg/R/WindowSpec.R ---------------------------------------------------------------------- diff --git a/R/pkg/R/WindowSpec.R b/R/pkg/R/WindowSpec.R index 4ac83c2..81beac9 100644 --- a/R/pkg/R/WindowSpec.R +++ b/R/pkg/R/WindowSpec.R @@ -203,7 +203,8 @@ setMethod("rangeBetween", #' @aliases over,Column,WindowSpec-method #' @family colum_func #' @export -#' @examples \dontrun{ +#' @examples +#' \dontrun{ #' df <- createDataFrame(mtcars) #' #' # Partition by am (transmission) and order by hp (horsepower) http://git-wip-us.apache.org/repos/asf/spark/blob/7f203a24/R/pkg/R/column.R ---------------------------------------------------------------------- diff --git a/R/pkg/R/column.R b/R/pkg/R/column.R index 5740780..a5c2ea8 100644 --- a/R/pkg/R/column.R +++ b/R/pkg/R/column.R @@ -135,7 +135,8 @@ createMethods() #' @aliases alias,Column-method #' @family colum_func #' @export -#' @examples \dontrun{ +#' @examples +#' \dontrun{ #' df <- createDataFrame(iris) #' #' head(select( @@ -244,7 +245,8 @@ setMethod("between", signature(x = "Column"), #' @family colum_func #' @aliases cast,Column-method #' -#' @examples \dontrun{ +#' @examples +#' \dontrun{ #' cast(df$age, "string") #' } #' @note cast since 1.4.0 http://git-wip-us.apache.org/repos/asf/spark/blob/7f203a24/R/pkg/R/functions.R ---------------------------------------------------------------------- diff --git a/R/pkg/R/functions.R b/R/pkg/R/functions.R index a6c2dea..06a9019 100644 --- a/R/pkg/R/functions.R +++ b/R/pkg/R/functions.R @@ -3257,7 +3257,8 @@ setMethod("when", signature(condition = "Column", value = "ANY"), #' @aliases ifelse,Column-method #' @seealso \link{when} #' @export -#' @examples \dontrun{ +#' @examples +#' \dontrun{ #' ifelse(df$a > 1 & df$b > 2, 0, 1) #' ifelse(df$a > 1, df$a, 1) #' } @@ -3292,7 +3293,8 @@ setMethod("ifelse", #' @family window functions #' @aliases cume_dist,missing-method #' @export -#' @examples \dontrun{ +#' @examples +#' \dontrun{ #' df <- createDataFrame(mtcars) #' ws <- orderBy(windowPartitionBy("am"), "hp") #' out <- select(df, over(cume_dist(), ws), df$hp, df$am) @@ -3321,7 +3323,8 @@ setMethod("cume_dist", #' @family window functions #' @aliases dense_rank,missing-method #' @export -#' @examples \dontrun{ +#' @examples +#' \dontrun{ #' df <- createDataFrame(mtcars) #' ws <- orderBy(windowPartitionBy("am"), "hp") #' out <- select(df, over(dense_rank(), ws), df$hp, df$am) @@ -3352,7 +3355,8 @@ setMethod("dense_rank", #' @aliases lag,characterOrColumn-method #' @family window functions #' @export -#' @examples \dontrun{ +#' @examples +#' \dontrun{ #' df <- createDataFrame(mtcars) #' #' # Partition by am (transmission) and order by hp (horsepower) @@ -3395,7 +3399,8 @@ setMethod("lag", #' @family window functions #' @aliases lead,characterOrColumn,numeric-method #' @export -#' @examples \dontrun{ +#' @examples +#' \dontrun{ #' df <- createDataFrame(mtcars) #' #' # Partition by am (transmission) and order by hp (horsepower) @@ -3434,7 +3439,8 @@ setMethod("lead", #' @aliases ntile,numeric-method #' @family window functions #' @export -#' @examples \dontrun{ +#' @examples +#' \dontrun{ #' df <- createDataFrame(mtcars) #' #' # Partition by am (transmission) and order by hp (horsepower) @@ -3466,7 +3472,8 @@ setMethod("ntile", #' @family window functions #' @aliases percent_rank,missing-method #' @export -#' @examples \dontrun{ +#' @examples +#' \dontrun{ #' df <- createDataFrame(mtcars) #' ws <- orderBy(windowPartitionBy("am"), "hp") #' out <- select(df, over(percent_rank(), ws), df$hp, df$am) @@ -3496,7 +3503,8 @@ setMethod("percent_rank", #' @family window functions #' @aliases rank,missing-method #' @export -#' @examples \dontrun{ +#' @examples +#' \dontrun{ #' df <- createDataFrame(mtcars) #' ws <- orderBy(windowPartitionBy("am"), "hp") #' out <- select(df, over(rank(), ws), df$hp, df$am) @@ -3533,7 +3541,8 @@ setMethod("rank", #' @aliases row_number,missing-method #' @family window functions #' @export -#' @examples \dontrun{ +#' @examples +#' \dontrun{ #' df <- createDataFrame(mtcars) #' ws <- orderBy(windowPartitionBy("am"), "hp") #' out <- select(df, over(row_number(), ws), df$hp, df$am) @@ -3761,7 +3770,8 @@ setMethod("collect_set", #' @family string functions #' @aliases split_string,Column-method #' @export -#' @examples \dontrun{ +#' @examples +#' \dontrun{ #' df <- read.text("README.md") #' #' head(select(df, split_string(df$value, "\\s+"))) @@ -3790,7 +3800,8 @@ setMethod("split_string", #' @family string functions #' @aliases repeat_string,Column-method #' @export -#' @examples \dontrun{ +#' @examples +#' \dontrun{ #' df <- read.text("README.md") #' #' first(select(df, repeat_string(df$value, 3))) @@ -3819,7 +3830,8 @@ setMethod("repeat_string", #' @family collection functions #' @aliases explode_outer,Column-method #' @export -#' @examples \dontrun{ +#' @examples +#' \dontrun{ #' df <- createDataFrame(data.frame( #' id = c(1, 2, 3), text = c("a,b,c", NA, "d,e") #' )) @@ -3847,7 +3859,8 @@ setMethod("explode_outer", #' @family collection functions #' @aliases posexplode_outer,Column-method #' @export -#' @examples \dontrun{ +#' @examples +#' \dontrun{ #' df <- createDataFrame(data.frame( #' id = c(1, 2, 3), text = c("a,b,c", NA, "d,e") #' )) @@ -3875,7 +3888,8 @@ setMethod("posexplode_outer", #' @aliases not,Column-method #' @family non-aggregate functions #' @export -#' @examples \dontrun{ +#' @examples +#' \dontrun{ #' df <- createDataFrame(data.frame( #' is_true = c(TRUE, FALSE, NA), #' flag = c(1, 0, 1) @@ -3908,7 +3922,8 @@ setMethod("not", #' @family aggregate functions #' @aliases grouping_bit,Column-method #' @export -#' @examples \dontrun{ +#' @examples +#' \dontrun{ #' df <- createDataFrame(mtcars) #' #' # With cube @@ -3949,7 +3964,8 @@ setMethod("grouping_bit", #' @family aggregate functions #' @aliases grouping_id,Column-method #' @export -#' @examples \dontrun{ +#' @examples +#' \dontrun{ #' df <- createDataFrame(mtcars) #' #' # With cube @@ -3987,7 +4003,8 @@ setMethod("grouping_id", #' @family non-aggregate functions #' @aliases input_file_name,missing-method #' @export -#' @examples \dontrun{ +#' @examples +#' \dontrun{ #' df <- read.text("README.md") #' #' head(select(df, input_file_name())) --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org For additional commands, e-mail: commits-h...@spark.apache.org
