1717
1818# window.R - Utility functions for defining window in DataFrames
1919
20- # ' window.partitionBy
20+ # ' windowPartitionBy
2121# '
2222# ' Creates a WindowSpec with the partitioning defined.
2323# '
24- # ' @rdname window.partitionBy
25- # ' @name window.partitionBy
26- # ' @aliases window.partitionBy,character-method
24+ # ' @param col A column name or Column by which rows are partitioned to
25+ # ' windows.
26+ # ' @param ... Optional column names or Columns in addition to col, by
27+ # ' which rows are partitioned to windows.
28+ # '
29+ # ' @rdname windowPartitionBy
30+ # ' @name windowPartitionBy
31+ # ' @aliases windowPartitionBy,character-method
2732# ' @export
2833# ' @examples
2934# ' \dontrun{
30- # ' ws <- window.partitionBy ("key1", "key2")
35+ # ' ws <- windowPartitionBy ("key1", "key2")
3136# ' df1 <- select(df, over(lead("value", 1), ws))
3237# '
33- # ' ws <- window.partitionBy (df$key1, df$key2)
38+ # ' ws <- windowPartitionBy (df$key1, df$key2)
3439# ' df1 <- select(df, over(lead("value", 1), ws))
3540# ' }
36- # ' @note window.partitionBy (character) since 2.0.0
37- setMethod ("window.partitionBy ",
38- signature(x = " character" ),
39- function (x , ... ) {
41+ # ' @note windowPartitionBy (character) since 2.0.0
42+ setMethod ("windowPartitionBy ",
43+ signature(col = " character" ),
44+ function (col , ... ) {
4045 windowSpec(
4146 callJStatic(" org.apache.spark.sql.expressions.Window" ,
4247 " partitionBy" ,
4348 x ,
4449 list (... )))
4550 })
4651
47- # ' @rdname window.partitionBy
48- # ' @name window.partitionBy
49- # ' @aliases window.partitionBy ,Column-method
52+ # ' @rdname windowPartitionBy
53+ # ' @name windowPartitionBy
54+ # ' @aliases windowPartitionBy ,Column-method
5055# ' @export
51- # ' @note window.partitionBy (Column) since 2.0.0
52- setMethod ("window.partitionBy ",
53- signature(x = " Column" ),
54- function (x , ... ) {
55- jcols <- lapply(list (x , ... ), function (c ) {
56+ # ' @note windowPartitionBy (Column) since 2.0.0
57+ setMethod ("windowPartitionBy ",
58+ signature(col = " Column" ),
59+ function (col , ... ) {
60+ jcols <- lapply(list (col , ... ), function (c ) {
5661 c @ jc
5762 })
5863 windowSpec(
@@ -61,42 +66,47 @@ setMethod("window.partitionBy",
6166 jcols ))
6267 })
6368
64- # ' window.orderBy
69+ # ' windowOrderBy
6570# '
6671# ' Creates a WindowSpec with the ordering defined.
6772# '
68- # ' @rdname window.orderBy
69- # ' @name window.orderBy
70- # ' @aliases window.orderBy,character-method
73+ # ' @param col A column name or Column by which rows are ordered within
74+ # ' windows.
75+ # ' @param ... Optional column names or Columns in addition to col, by
76+ # ' which rows are ordered within windows.
77+ # '
78+ # ' @rdname windowOrderBy
79+ # ' @name windowOrderBy
80+ # ' @aliases windowOrderBy,character-method
7181# ' @export
7282# ' @examples
7383# ' \dontrun{
74- # ' ws <- window.orderBy ("key1", "key2")
84+ # ' ws <- windowOrderBy ("key1", "key2")
7585# ' df1 <- select(df, over(lead("value", 1), ws))
7686# '
77- # ' ws <- window.orderBy (df$key1, df$key2)
87+ # ' ws <- windowOrderBy (df$key1, df$key2)
7888# ' df1 <- select(df, over(lead("value", 1), ws))
7989# ' }
80- # ' @note window.orderBy (character) since 2.0.0
81- setMethod ("window.orderBy ",
82- signature(x = " character" ),
83- function (x , ... ) {
90+ # ' @note windowOrderBy (character) since 2.0.0
91+ setMethod ("windowOrderBy ",
92+ signature(col = " character" ),
93+ function (col , ... ) {
8494 windowSpec(
8595 callJStatic(" org.apache.spark.sql.expressions.Window" ,
8696 " orderBy" ,
87- x ,
97+ col ,
8898 list (... )))
8999 })
90100
91- # ' @rdname window.orderBy
92- # ' @name window.orderBy
93- # ' @aliases window.orderBy ,Column-method
101+ # ' @rdname windowOrderBy
102+ # ' @name windowOrderBy
103+ # ' @aliases windowOrderBy ,Column-method
94104# ' @export
95- # ' @note window.orderBy (Column) since 2.0.0
96- setMethod ("window.orderBy ",
97- signature(x = " Column" ),
98- function (x , ... ) {
99- jcols <- lapply(list (x , ... ), function (c ) {
105+ # ' @note windowOrderBy (Column) since 2.0.0
106+ setMethod ("windowOrderBy ",
107+ signature(col = " Column" ),
108+ function (col , ... ) {
109+ jcols <- lapply(list (col , ... ), function (c ) {
100110 c @ jc
101111 })
102112 windowSpec(
0 commit comments