You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spark.apache.org by sh...@apache.org on 2016/08/15 18:03:08 UTC
spark git commit: [SPARK-16508][SPARKR] Split docs for arrange and
orderBy methods
Repository: spark
Updated Branches:
refs/heads/master 3d8bfe7a3 -> 564fe614c
[SPARK-16508][SPARKR] Split docs for arrange and orderBy methods
## What changes were proposed in this pull request?
This PR splits arrange and orderBy methods according to their functionality (the former for sorting sparkDataFrame and the latter for windowSpec).
## How was this patch tested?
Author: Junyang Qian <ju...@databricks.com>
Closes #14522 from junyangq/SPARK-16508-0.
Project: http://git-wip-us.apache.org/repos/asf/spark/repo
Commit: http://git-wip-us.apache.org/repos/asf/spark/commit/564fe614
Tree: http://git-wip-us.apache.org/repos/asf/spark/tree/564fe614
Diff: http://git-wip-us.apache.org/repos/asf/spark/diff/564fe614
Branch: refs/heads/master
Commit: 564fe614c11deb657e0ac9e6b75e65370c48b7fe
Parents: 3d8bfe7
Author: Junyang Qian <ju...@databricks.com>
Authored: Mon Aug 15 11:03:03 2016 -0700
Committer: Shivaram Venkataraman <sh...@cs.berkeley.edu>
Committed: Mon Aug 15 11:03:03 2016 -0700
----------------------------------------------------------------------
.gitignore | 1 +
R/pkg/R/DataFrame.R | 11 +++++------
R/pkg/R/WindowSpec.R | 18 ++++++++++--------
R/pkg/R/generics.R | 2 +-
4 files changed, 17 insertions(+), 15 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/spark/blob/564fe614/.gitignore
----------------------------------------------------------------------
diff --git a/.gitignore b/.gitignore
index 225aa61..0991976 100644
--- a/.gitignore
+++ b/.gitignore
@@ -82,3 +82,4 @@ spark-warehouse/
*.Rproj
*.Rproj.*
+.Rproj.user
http://git-wip-us.apache.org/repos/asf/spark/blob/564fe614/R/pkg/R/DataFrame.R
----------------------------------------------------------------------
diff --git a/R/pkg/R/DataFrame.R b/R/pkg/R/DataFrame.R
index 0ce4696..09be06d 100644
--- a/R/pkg/R/DataFrame.R
+++ b/R/pkg/R/DataFrame.R
@@ -2048,14 +2048,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
@@ -2120,7 +2120,6 @@ setMethod("arrange",
})
#' @rdname arrange
-#' @name orderBy
#' @aliases orderBy,SparkDataFrame,characterOrColumn-method
#' @export
#' @note orderBy(SparkDataFrame, characterOrColumn) since 1.4.0
http://git-wip-us.apache.org/repos/asf/spark/blob/564fe614/R/pkg/R/WindowSpec.R
----------------------------------------------------------------------
diff --git a/R/pkg/R/WindowSpec.R b/R/pkg/R/WindowSpec.R
index 4746380..751ba3f 100644
--- a/R/pkg/R/WindowSpec.R
+++ b/R/pkg/R/WindowSpec.R
@@ -82,16 +82,18 @@ setMethod("partitionBy",
}
})
-#' orderBy
+#' Ordering Columns in a WindowSpec
#'
#' Defines the ordering columns in a WindowSpec.
-#'
#' @param x a WindowSpec
-#' @return a WindowSpec
-#' @rdname arrange
+#' @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{
@@ -105,7 +107,7 @@ setMethod("orderBy",
windowSpec(callJMethod(x@sws, "orderBy", col, list(...)))
})
-#' @rdname arrange
+#' @rdname orderBy
#' @name orderBy
#' @aliases orderBy,WindowSpec,Column-method
#' @export
@@ -122,7 +124,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 +156,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 +190,7 @@ setMethod("rangeBetween",
#' over
#'
-#' Define a windowing column.
+#' Define a windowing column.
#'
#' @rdname over
#' @name over
http://git-wip-us.apache.org/repos/asf/spark/blob/564fe614/R/pkg/R/generics.R
----------------------------------------------------------------------
diff --git a/R/pkg/R/generics.R b/R/pkg/R/generics.R
index e7444ac..10a0912 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") })
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@spark.apache.org
For additional commands, e-mail: commits-help@spark.apache.org