From 0876b7588cee1b2d39ffe8869e6b8320d8e27d1e Mon Sep 17 00:00:00 2001 From: Junyang Qian Date: Fri, 5 Aug 2016 15:41:39 -0700 Subject: [PATCH 1/4] Separate docs for arrange and orderBy methods according to their functionality --- .gitignore | 1 + R/pkg/R/DataFrame.R | 12 ++++++------ R/pkg/R/WindowSpec.R | 16 +++++----------- R/pkg/R/generics.R | 10 +++++++++- 4 files changed, 21 insertions(+), 18 deletions(-) diff --git a/.gitignore b/.gitignore index 225aa61eaa172..0991976abfb8b 100644 --- a/.gitignore +++ b/.gitignore @@ -82,3 +82,4 @@ spark-warehouse/ *.Rproj *.Rproj.* +.Rproj.user diff --git a/R/pkg/R/DataFrame.R b/R/pkg/R/DataFrame.R index a4733313ed16c..f8d07e05a2d3f 100644 --- a/R/pkg/R/DataFrame.R +++ b/R/pkg/R/DataFrame.R @@ -2049,14 +2049,14 @@ setMethod("rename", setClassUnion("characterOrColumn", c("character", "Column")) -#' Arrange +#' Arrange Rows by Variables #' #' Sort a SparkDataFrame by the specified column(s). #' -#' @param x A SparkDataFrame to be sorted. -#' @param col A character or Column object vector indicating the fields to sort on -#' @param ... Additional sorting fields -#' @param decreasing A logical argument indicating sorting order for columns when +#' @param x a SparkDataFrame to be sorted. +#' @param col a character or Column object indicating the fields to sort on +#' @param ... additional sorting fields +#' @param decreasing a logical argument indicating sorting order for columns when #' a character vector is specified for col #' @return A SparkDataFrame where all elements are sorted. #' @family SparkDataFrame functions @@ -2121,7 +2121,7 @@ setMethod("arrange", }) #' @rdname arrange -#' @name orderBy +#' @name arrange #' @aliases orderBy,SparkDataFrame,characterOrColumn-method #' @export #' @note orderBy(SparkDataFrame, characterOrColumn) since 1.4.0 diff --git a/R/pkg/R/WindowSpec.R b/R/pkg/R/WindowSpec.R index 4746380096245..86ea3f9c6e17c 100644 --- a/R/pkg/R/WindowSpec.R +++ b/R/pkg/R/WindowSpec.R @@ -82,13 +82,7 @@ setMethod("partitionBy", } }) -#' orderBy -#' -#' Defines the ordering columns in a WindowSpec. -#' -#' @param x a WindowSpec -#' @return a WindowSpec -#' @rdname arrange +#' @rdname orderBy #' @name orderBy #' @aliases orderBy,WindowSpec,character-method #' @family windowspec_method @@ -105,7 +99,7 @@ setMethod("orderBy", windowSpec(callJMethod(x@sws, "orderBy", col, list(...))) }) -#' @rdname arrange +#' @rdname orderBy #' @name orderBy #' @aliases orderBy,WindowSpec,Column-method #' @export @@ -122,7 +116,7 @@ setMethod("orderBy", #' rowsBetween #' #' Defines the frame boundaries, from `start` (inclusive) to `end` (inclusive). -#' +#' #' Both `start` and `end` are relative positions from the current row. For example, "0" means #' "current row", while "-1" means the row before the current row, and "5" means the fifth row #' after the current row. @@ -154,7 +148,7 @@ setMethod("rowsBetween", #' rangeBetween #' #' Defines the frame boundaries, from `start` (inclusive) to `end` (inclusive). -#' +#' #' Both `start` and `end` are relative from the current row. For example, "0" means "current row", #' while "-1" means one off before the current row, and "5" means the five off after the #' current row. @@ -188,7 +182,7 @@ setMethod("rangeBetween", #' over #' -#' Define a windowing column. +#' Define a windowing column. #' #' @rdname over #' @name over diff --git a/R/pkg/R/generics.R b/R/pkg/R/generics.R index e7444ac2467d8..1277c41788ca9 100644 --- a/R/pkg/R/generics.R +++ b/R/pkg/R/generics.R @@ -551,7 +551,15 @@ setGeneric("merge") #' @export setGeneric("mutate", function(.data, ...) {standardGeneric("mutate") }) -#' @rdname arrange +#' Ordering Columns in a WindowSpec +#' +#' Defines the ordering columns in a WindowSpec. +#' @param x a WindowSpec +#' @param col a character or Column object indicating an ordering column +#' @param ... additional sorting fields +#' @return A WindowSpec +#' @rdname orderBy +#' @seealso See \link{arrange} for use in sorting a SparkDataFrame #' @export setGeneric("orderBy", function(x, col, ...) { standardGeneric("orderBy") }) From c2445f3c6829d9372569ee93b3cf6bf9eaa3da3d Mon Sep 17 00:00:00 2001 From: Junyang Qian Date: Sun, 7 Aug 2016 10:08:07 -0700 Subject: [PATCH 2/4] Move detailed doc of orderBy from generic.R to WindowSpec.R --- R/pkg/R/WindowSpec.R | 10 +++++++++- R/pkg/R/generics.R | 8 -------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/R/pkg/R/WindowSpec.R b/R/pkg/R/WindowSpec.R index 86ea3f9c6e17c..1f65647dc1cda 100644 --- a/R/pkg/R/WindowSpec.R +++ b/R/pkg/R/WindowSpec.R @@ -82,10 +82,18 @@ setMethod("partitionBy", } }) -#' @rdname orderBy +#' Ordering Columns in a WindowSpec +#' +#' Defines the ordering columns in a WindowSpec. +#' @param x a WindowSpec +#' @param col a character or Column object indicating an ordering column +#' @param ... additional sorting fields +#' @return A WindowSpec #' @name orderBy +#' @rdname orderBy #' @aliases orderBy,WindowSpec,character-method #' @family windowspec_method +#' @seealso See \link{arrange} for use in sorting a SparkDataFrame #' @export #' @examples #' \dontrun{ diff --git a/R/pkg/R/generics.R b/R/pkg/R/generics.R index 1277c41788ca9..10a09129ec927 100644 --- a/R/pkg/R/generics.R +++ b/R/pkg/R/generics.R @@ -551,15 +551,7 @@ setGeneric("merge") #' @export setGeneric("mutate", function(.data, ...) {standardGeneric("mutate") }) -#' Ordering Columns in a WindowSpec -#' -#' Defines the ordering columns in a WindowSpec. -#' @param x a WindowSpec -#' @param col a character or Column object indicating an ordering column -#' @param ... additional sorting fields -#' @return A WindowSpec #' @rdname orderBy -#' @seealso See \link{arrange} for use in sorting a SparkDataFrame #' @export setGeneric("orderBy", function(x, col, ...) { standardGeneric("orderBy") }) From f811a7d6197e24a78ecb43a4ccb0f8054b27c03c Mon Sep 17 00:00:00 2001 From: Junyang Qian Date: Mon, 8 Aug 2016 09:34:05 -0700 Subject: [PATCH 3/4] Minor fixes of name and rdname --- R/pkg/R/DataFrame.R | 2 +- R/pkg/R/WindowSpec.R | 2 +- R/pkg/R/generics.R | 6 +++++- 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/R/pkg/R/DataFrame.R b/R/pkg/R/DataFrame.R index f8d07e05a2d3f..422a939380456 100644 --- a/R/pkg/R/DataFrame.R +++ b/R/pkg/R/DataFrame.R @@ -2121,7 +2121,7 @@ setMethod("arrange", }) #' @rdname arrange -#' @name arrange +#' @name orderBy #' @aliases orderBy,SparkDataFrame,characterOrColumn-method #' @export #' @note orderBy(SparkDataFrame, characterOrColumn) since 1.4.0 diff --git a/R/pkg/R/WindowSpec.R b/R/pkg/R/WindowSpec.R index 1f65647dc1cda..751ba3fde954d 100644 --- a/R/pkg/R/WindowSpec.R +++ b/R/pkg/R/WindowSpec.R @@ -88,7 +88,7 @@ setMethod("partitionBy", #' @param x a WindowSpec #' @param col a character or Column object indicating an ordering column #' @param ... additional sorting fields -#' @return A WindowSpec +#' @return A WindowSpec. #' @name orderBy #' @rdname orderBy #' @aliases orderBy,WindowSpec,character-method diff --git a/R/pkg/R/generics.R b/R/pkg/R/generics.R index 10a09129ec927..cd1eb02fbfe7c 100644 --- a/R/pkg/R/generics.R +++ b/R/pkg/R/generics.R @@ -551,7 +551,7 @@ setGeneric("merge") #' @export setGeneric("mutate", function(.data, ...) {standardGeneric("mutate") }) -#' @rdname orderBy +#' @rdname arrange #' @export setGeneric("orderBy", function(x, col, ...) { standardGeneric("orderBy") }) @@ -771,6 +771,10 @@ setGeneric("over", function(x, window) { standardGeneric("over") }) ###################### WindowSpec Methods ########################## +#' @rdname orderBy +#' @export +setGeneric("orderBy", function(x, col, ...) { standardGeneric("orderBy") }) + #' @rdname rowsBetween #' @export setGeneric("rowsBetween", function(x, start, end) { standardGeneric("rowsBetween") }) From a52256bfa776cab41eac15e55246a421cfacb761 Mon Sep 17 00:00:00 2001 From: Junyang Qian Date: Wed, 10 Aug 2016 10:18:53 -0700 Subject: [PATCH 4/4] Fix Rd files with duplicated alias 'orderBy' --- R/pkg/R/DataFrame.R | 1 - R/pkg/R/generics.R | 6 +----- 2 files changed, 1 insertion(+), 6 deletions(-) diff --git a/R/pkg/R/DataFrame.R b/R/pkg/R/DataFrame.R index 422a939380456..ba266e278bd4d 100644 --- a/R/pkg/R/DataFrame.R +++ b/R/pkg/R/DataFrame.R @@ -2121,7 +2121,6 @@ setMethod("arrange", }) #' @rdname arrange -#' @name orderBy #' @aliases orderBy,SparkDataFrame,characterOrColumn-method #' @export #' @note orderBy(SparkDataFrame, characterOrColumn) since 1.4.0 diff --git a/R/pkg/R/generics.R b/R/pkg/R/generics.R index cd1eb02fbfe7c..10a09129ec927 100644 --- a/R/pkg/R/generics.R +++ b/R/pkg/R/generics.R @@ -551,7 +551,7 @@ setGeneric("merge") #' @export setGeneric("mutate", function(.data, ...) {standardGeneric("mutate") }) -#' @rdname arrange +#' @rdname orderBy #' @export setGeneric("orderBy", function(x, col, ...) { standardGeneric("orderBy") }) @@ -771,10 +771,6 @@ setGeneric("over", function(x, window) { standardGeneric("over") }) ###################### WindowSpec Methods ########################## -#' @rdname orderBy -#' @export -setGeneric("orderBy", function(x, col, ...) { standardGeneric("orderBy") }) - #' @rdname rowsBetween #' @export setGeneric("rowsBetween", function(x, start, end) { standardGeneric("rowsBetween") })