From 5e0716ad1e3828c81124325c1cb2dfea72faf030 Mon Sep 17 00:00:00 2001 From: Shivaram Venkataraman Date: Fri, 8 May 2015 11:32:58 -0700 Subject: [PATCH] Fix some roxygen bugs --- R/pkg/R/DataFrame.R | 14 +++++++------- R/pkg/R/column.R | 16 ++++++++-------- R/pkg/R/generics.R | 4 ++-- R/pkg/R/group.R | 2 +- 4 files changed, 18 insertions(+), 18 deletions(-) diff --git a/R/pkg/R/DataFrame.R b/R/pkg/R/DataFrame.R index 87ad50cdf0fdc..8a9d2dd45c588 100644 --- a/R/pkg/R/DataFrame.R +++ b/R/pkg/R/DataFrame.R @@ -480,7 +480,7 @@ setMethod("distinct", #' @param withReplacement Sampling with replacement or not #' @param fraction The (rough) sample target fraction #' @rdname sampleDF -#' @alias sample_frac +#' @aliases sample_frac #' @export #' @examples #'\dontrun{ @@ -503,7 +503,7 @@ setMethod("sampleDF", }) #' @rdname sampleDF -#' @alias sampleDF +#' @aliases sampleDF setMethod("sample_frac", signature(x = "DataFrame", withReplacement = "logical", fraction = "numeric"), @@ -692,7 +692,7 @@ setMethod("toRDD", #' @param x a DataFrame #' @return a GroupedData #' @seealso GroupedData -#' @alias group_by +#' @aliases group_by #' @rdname groupBy #' @export #' @examples @@ -730,7 +730,7 @@ setMethod("group_by", #' #' @param x a DataFrame #' @rdname DataFrame -#' @alias summarize +#' @aliases summarize #' @export setMethod("agg", signature(x = "DataFrame"), @@ -739,7 +739,7 @@ setMethod("agg", }) #' @rdname DataFrame -#' @alias agg +#' @aliases agg setMethod("summarize", signature(x = "DataFrame"), function(x, ...) { @@ -982,7 +982,7 @@ setMethod("withColumn", #' @param col a named argument of the form name = col #' @return A new DataFrame with the new columns added. #' @rdname withColumn -#' @alias withColumn +#' @aliases withColumn #' @export #' @examples #'\dontrun{ @@ -1049,7 +1049,7 @@ setMethod("withColumnRenamed", #' @param newCol A named pair of the form new_column_name = existing_column #' @return A DataFrame with the column name changed. #' @rdname withColumnRenamed -#' @alias withColumnRenamed +#' @aliases withColumnRenamed #' @export #' @examples #'\dontrun{ diff --git a/R/pkg/R/column.R b/R/pkg/R/column.R index 19503c94faa11..9a68445ab451a 100644 --- a/R/pkg/R/column.R +++ b/R/pkg/R/column.R @@ -130,9 +130,9 @@ createMethods() #' alias #' -#' @rdname column -#' #' Set a new name for a column + +#' @rdname column setMethod("alias", signature(object = "Column"), function(object, data) { @@ -143,6 +143,8 @@ setMethod("alias", } }) +#' substr +#' #' An expression that returns a substring. #' #' @rdname column @@ -181,8 +183,7 @@ setMethod("cast", #' Approx Count Distinct #' #' @rdname column -#' -#' Returns the approximate number of distinct items in a group. +#' @return the approximate number of distinct items in a group. setMethod("approxCountDistinct", signature(x = "Column"), function(x, rsd = 0.95) { @@ -193,8 +194,7 @@ setMethod("approxCountDistinct", #' Count Distinct #' #' @rdname column -#' -#' returns the number of distinct items in a group. +#' @return the number of distinct items in a group. setMethod("countDistinct", signature(x = "Column"), function(x, ...) { @@ -207,7 +207,7 @@ setMethod("countDistinct", }) #' @rdname column -#' @alias countDistinct +#' @aliases countDistinct setMethod("n_distinct", signature(x = "Column"), function(x, ...) { @@ -215,7 +215,7 @@ setMethod("n_distinct", }) #' @rdname column -#' @alias count +#' @aliases count setMethod("n", signature(x = "Column"), function(x) { diff --git a/R/pkg/R/generics.R b/R/pkg/R/generics.R index 8c4f3a4b54a1f..557128a419f19 100644 --- a/R/pkg/R/generics.R +++ b/R/pkg/R/generics.R @@ -436,7 +436,7 @@ setGeneric("isLocal", function(x) { standardGeneric("isLocal") }) #' @export setGeneric("limit", function(x, num) {standardGeneric("limit") }) -#' @rdname mutate +#' @rdname withColumn #' @export setGeneric("mutate", function(x, ...) {standardGeneric("mutate") }) @@ -500,7 +500,7 @@ setGeneric("selectExpr", function(x, expr, ...) { standardGeneric("selectExpr") #' @export setGeneric("showDF", function(x,...) { standardGeneric("showDF") }) -#' @rdname summarize +#' @rdname agg #' @export setGeneric("summarize", function(x,...) { standardGeneric("summarize") }) diff --git a/R/pkg/R/group.R b/R/pkg/R/group.R index ac76f6e0a2c20..5a7a8a2caba13 100644 --- a/R/pkg/R/group.R +++ b/R/pkg/R/group.R @@ -112,7 +112,7 @@ setMethod("agg", }) #' @rdname agg -#' @alias agg +#' @aliases agg setMethod("summarize", signature(x = "GroupedData"), function(x, ...) {