Skip to content

[SparkR] Fix bad examples in DataFrame methods and style issues #18003

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
actuaryzhang wants to merge 4 commits into from
Closed

[SparkR] Fix bad examples in DataFrame methods and style issues #18003

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d2f4d29
correct bad examples
May 16, 2017
a919d9f
fix dontrun style
May 16, 2017
298c983
Revert "fix dontrun style"
May 16, 2017
1450dd1
address comments
May 17, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions R/pkg/R/DataFrame.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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", ])
#' }
Expand Down Expand Up @@ -3175,7 +3176,8 @@ setMethod("with",
#' @aliases str,SparkDataFrame-method
#' @family SparkDataFrame functions
#' @param object a SparkDataFrame
#' @examples \dontrun{
#' @examples
#' \dontrun{
Copy link
Contributor

@bdwyer2 bdwyer2 May 16, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are a lot of these in functions.R. Maybe you could fix them too with this PR?

#' # Create a SparkDataFrame from the Iris dataset
#' irisDF <- createDataFrame(iris)
#'
Expand Down
3 changes: 2 additions & 1 deletion R/pkg/R/WindowSpec.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
6 changes: 4 additions & 2 deletions R/pkg/R/column.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,8 @@ createMethods()
#' @aliases alias,Column-method
#' @family colum_func
#' @export
#' @examples \dontrun{
#' @examples
#' \dontrun{
#' df <- createDataFrame(iris)
#'
#' head(select(
Expand Down Expand Up @@ -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
Expand Down
51 changes: 34 additions & 17 deletions R/pkg/R/functions.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3255,7 +3255,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)
#' }
Expand Down Expand Up @@ -3290,7 +3291,8 @@ setMethod("ifelse",
#' @family window_funcs
#' @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)
Expand Down Expand Up @@ -3319,7 +3321,8 @@ setMethod("cume_dist",
#' @family window_funcs
#' @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)
Expand Down Expand Up @@ -3350,7 +3353,8 @@ setMethod("dense_rank",
#' @aliases lag,characterOrColumn-method
#' @family window_funcs
#' @export
#' @examples \dontrun{
#' @examples
#' \dontrun{
#' df <- createDataFrame(mtcars)
#'
#' # Partition by am (transmission) and order by hp (horsepower)
Expand Down Expand Up @@ -3393,7 +3397,8 @@ setMethod("lag",
#' @family window_funcs
#' @aliases lead,characterOrColumn,numeric-method
#' @export
#' @examples \dontrun{
#' @examples
#' \dontrun{
#' df <- createDataFrame(mtcars)
#'
#' # Partition by am (transmission) and order by hp (horsepower)
Expand Down Expand Up @@ -3432,7 +3437,8 @@ setMethod("lead",
#' @aliases ntile,numeric-method
#' @family window_funcs
#' @export
#' @examples \dontrun{
#' @examples
#' \dontrun{
#' df <- createDataFrame(mtcars)
#'
#' # Partition by am (transmission) and order by hp (horsepower)
Expand Down Expand Up @@ -3464,7 +3470,8 @@ setMethod("ntile",
#' @family window_funcs
#' @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)
Expand Down Expand Up @@ -3494,7 +3501,8 @@ setMethod("percent_rank",
#' @family window_funcs
#' @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)
Expand Down Expand Up @@ -3531,7 +3539,8 @@ setMethod("rank",
#' @aliases row_number,missing-method
#' @family window_funcs
#' @export
#' @examples \dontrun{
#' @examples
#' \dontrun{
#' df <- createDataFrame(mtcars)
#' ws <- orderBy(windowPartitionBy("am"), "hp")
#' out <- select(df, over(row_number(), ws), df$hp, df$am)
Expand Down Expand Up @@ -3759,7 +3768,8 @@ setMethod("collect_set",
#' @family string_funcs
#' @aliases split_string,Column-method
#' @export
#' @examples \dontrun{
#' @examples
#' \dontrun{
#' df <- read.text("README.md")
#'
#' head(select(df, split_string(df$value, "\\s+")))
Expand Down Expand Up @@ -3788,7 +3798,8 @@ setMethod("split_string",
#' @family string_funcs
#' @aliases repeat_string,Column-method
#' @export
#' @examples \dontrun{
#' @examples
#' \dontrun{
#' df <- read.text("README.md")
#'
#' first(select(df, repeat_string(df$value, 3)))
Expand Down Expand Up @@ -3817,7 +3828,8 @@ setMethod("repeat_string",
#' @family collection_funcs
#' @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")
#' ))
Expand Down Expand Up @@ -3845,7 +3857,8 @@ setMethod("explode_outer",
#' @family collection_funcs
#' @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")
#' ))
Expand Down Expand Up @@ -3873,7 +3886,8 @@ setMethod("posexplode_outer",
#' @aliases not,Column-method
#' @family normal_funcs
#' @export
#' @examples \dontrun{
#' @examples
#' \dontrun{
#' df <- createDataFrame(data.frame(
#' is_true = c(TRUE, FALSE, NA),
#' flag = c(1, 0, 1)
Expand Down Expand Up @@ -3906,7 +3920,8 @@ setMethod("not",
#' @family agg_funcs
#' @aliases grouping_bit,Column-method
#' @export
#' @examples \dontrun{
#' @examples
#' \dontrun{
#' df <- createDataFrame(mtcars)
#'
#' # With cube
Expand Down Expand Up @@ -3947,7 +3962,8 @@ setMethod("grouping_bit",
#' @family agg_funcs
#' @aliases grouping_id,Column-method
#' @export
#' @examples \dontrun{
#' @examples
#' \dontrun{
#' df <- createDataFrame(mtcars)
#'
#' # With cube
Expand Down Expand Up @@ -3985,7 +4001,8 @@ setMethod("grouping_id",
#' @family normal_funcs
#' @aliases input_file_name,missing-method
#' @export
#' @examples \dontrun{
#' @examples
#' \dontrun{
#' df <- read.text("README.md")
#'
#' head(select(df, input_file_name()))
Expand Down