Skip to content

Commit 5e0716a

Browse files
committed
Fix some roxygen bugs
1 parent 1254953 commit 5e0716a

File tree

4 files changed

+18
-18
lines changed

4 files changed

+18
-18
lines changed

R/pkg/R/DataFrame.R

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -480,7 +480,7 @@ setMethod("distinct",
480480
#' @param withReplacement Sampling with replacement or not
481481
#' @param fraction The (rough) sample target fraction
482482
#' @rdname sampleDF
483-
#' @alias sample_frac
483+
#' @aliases sample_frac
484484
#' @export
485485
#' @examples
486486
#'\dontrun{
@@ -503,7 +503,7 @@ setMethod("sampleDF",
503503
})
504504

505505
#' @rdname sampleDF
506-
#' @alias sampleDF
506+
#' @aliases sampleDF
507507
setMethod("sample_frac",
508508
signature(x = "DataFrame", withReplacement = "logical",
509509
fraction = "numeric"),
@@ -692,7 +692,7 @@ setMethod("toRDD",
692692
#' @param x a DataFrame
693693
#' @return a GroupedData
694694
#' @seealso GroupedData
695-
#' @alias group_by
695+
#' @aliases group_by
696696
#' @rdname groupBy
697697
#' @export
698698
#' @examples
@@ -730,7 +730,7 @@ setMethod("group_by",
730730
#'
731731
#' @param x a DataFrame
732732
#' @rdname DataFrame
733-
#' @alias summarize
733+
#' @aliases summarize
734734
#' @export
735735
setMethod("agg",
736736
signature(x = "DataFrame"),
@@ -739,7 +739,7 @@ setMethod("agg",
739739
})
740740

741741
#' @rdname DataFrame
742-
#' @alias agg
742+
#' @aliases agg
743743
setMethod("summarize",
744744
signature(x = "DataFrame"),
745745
function(x, ...) {
@@ -982,7 +982,7 @@ setMethod("withColumn",
982982
#' @param col a named argument of the form name = col
983983
#' @return A new DataFrame with the new columns added.
984984
#' @rdname withColumn
985-
#' @alias withColumn
985+
#' @aliases withColumn
986986
#' @export
987987
#' @examples
988988
#'\dontrun{
@@ -1049,7 +1049,7 @@ setMethod("withColumnRenamed",
10491049
#' @param newCol A named pair of the form new_column_name = existing_column
10501050
#' @return A DataFrame with the column name changed.
10511051
#' @rdname withColumnRenamed
1052-
#' @alias withColumnRenamed
1052+
#' @aliases withColumnRenamed
10531053
#' @export
10541054
#' @examples
10551055
#'\dontrun{

R/pkg/R/column.R

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -130,9 +130,9 @@ createMethods()
130130

131131
#' alias
132132
#'
133-
#' @rdname column
134-
#'
135133
#' Set a new name for a column
134+
135+
#' @rdname column
136136
setMethod("alias",
137137
signature(object = "Column"),
138138
function(object, data) {
@@ -143,6 +143,8 @@ setMethod("alias",
143143
}
144144
})
145145

146+
#' substr
147+
#'
146148
#' An expression that returns a substring.
147149
#'
148150
#' @rdname column
@@ -181,8 +183,7 @@ setMethod("cast",
181183
#' Approx Count Distinct
182184
#'
183185
#' @rdname column
184-
#'
185-
#' Returns the approximate number of distinct items in a group.
186+
#' @return the approximate number of distinct items in a group.
186187
setMethod("approxCountDistinct",
187188
signature(x = "Column"),
188189
function(x, rsd = 0.95) {
@@ -193,8 +194,7 @@ setMethod("approxCountDistinct",
193194
#' Count Distinct
194195
#'
195196
#' @rdname column
196-
#'
197-
#' returns the number of distinct items in a group.
197+
#' @return the number of distinct items in a group.
198198
setMethod("countDistinct",
199199
signature(x = "Column"),
200200
function(x, ...) {
@@ -207,15 +207,15 @@ setMethod("countDistinct",
207207
})
208208

209209
#' @rdname column
210-
#' @alias countDistinct
210+
#' @aliases countDistinct
211211
setMethod("n_distinct",
212212
signature(x = "Column"),
213213
function(x, ...) {
214214
countDistinct(x, ...)
215215
})
216216

217217
#' @rdname column
218-
#' @alias count
218+
#' @aliases count
219219
setMethod("n",
220220
signature(x = "Column"),
221221
function(x) {

R/pkg/R/generics.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -436,7 +436,7 @@ setGeneric("isLocal", function(x) { standardGeneric("isLocal") })
436436
#' @export
437437
setGeneric("limit", function(x, num) {standardGeneric("limit") })
438438

439-
#' @rdname mutate
439+
#' @rdname withColumn
440440
#' @export
441441
setGeneric("mutate", function(x, ...) {standardGeneric("mutate") })
442442

@@ -500,7 +500,7 @@ setGeneric("selectExpr", function(x, expr, ...) { standardGeneric("selectExpr")
500500
#' @export
501501
setGeneric("showDF", function(x,...) { standardGeneric("showDF") })
502502

503-
#' @rdname summarize
503+
#' @rdname agg
504504
#' @export
505505
setGeneric("summarize", function(x,...) { standardGeneric("summarize") })
506506

R/pkg/R/group.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ setMethod("agg",
112112
})
113113

114114
#' @rdname agg
115-
#' @alias agg
115+
#' @aliases agg
116116
setMethod("summarize",
117117
signature(x = "GroupedData"),
118118
function(x, ...) {

0 commit comments

Comments
 (0)