diff options
author | Eric Liang <ekl@databricks.com> | 2015-08-11 21:26:03 -0700 |
---|---|---|
committer | Xiangrui Meng <meng@databricks.com> | 2015-08-11 21:26:03 -0700 |
commit | 74a293f4537c6982345166f8883538f81d850872 (patch) | |
tree | 0b4c7f29f22c5b72de91c5e4e3a53bb2466a0bc2 /R | |
parent | 3ef0f32928fc383ad3edd5ad167212aeb9eba6e1 (diff) | |
download | spark-74a293f4537c6982345166f8883538f81d850872.tar.gz spark-74a293f4537c6982345166f8883538f81d850872.tar.bz2 spark-74a293f4537c6982345166f8883538f81d850872.zip |
[SPARK-9713] [ML] Document SparkR MLlib glm() integration in Spark 1.5
This documents the use of R model formulae in the SparkR guide. Also fixes some bugs in the R api doc.
mengxr
Author: Eric Liang <ekl@databricks.com>
Closes #8085 from ericl/docs.
Diffstat (limited to 'R')
-rw-r--r-- | R/pkg/R/generics.R | 4 | ||||
-rw-r--r-- | R/pkg/R/mllib.R | 8 |
2 files changed, 6 insertions, 6 deletions
diff --git a/R/pkg/R/generics.R b/R/pkg/R/generics.R index c43b947129..379a78b1d8 100644 --- a/R/pkg/R/generics.R +++ b/R/pkg/R/generics.R @@ -535,8 +535,8 @@ setGeneric("showDF", function(x,...) { standardGeneric("showDF") }) #' @export setGeneric("summarize", function(x,...) { standardGeneric("summarize") }) -##' rdname summary -##' @export +#' @rdname summary +#' @export setGeneric("summary", function(x, ...) { standardGeneric("summary") }) # @rdname tojson diff --git a/R/pkg/R/mllib.R b/R/pkg/R/mllib.R index b524d1fd87..cea3d760d0 100644 --- a/R/pkg/R/mllib.R +++ b/R/pkg/R/mllib.R @@ -56,10 +56,10 @@ setMethod("glm", signature(formula = "formula", family = "ANY", data = "DataFram #' #' Makes predictions from a model produced by glm(), similarly to R's predict(). #' -#' @param model A fitted MLlib model +#' @param object A fitted MLlib model #' @param newData DataFrame for testing #' @return DataFrame containing predicted values -#' @rdname glm +#' @rdname predict #' @export #' @examples #'\dontrun{ @@ -76,10 +76,10 @@ setMethod("predict", signature(object = "PipelineModel"), #' #' Returns the summary of a model produced by glm(), similarly to R's summary(). #' -#' @param model A fitted MLlib model +#' @param x A fitted MLlib model #' @return a list with a 'coefficient' component, which is the matrix of coefficients. See #' summary.glm for more information. -#' @rdname glm +#' @rdname summary #' @export #' @examples #'\dontrun{ |