Github user mengxr commented on a diff in the pull request:
https://github.com/apache/spark/pull/13820#discussion_r67961059
--- Diff: R/pkg/R/mllib.R ---
@@ -112,36 +125,23 @@ setMethod("spark.glm", signature(data =
"SparkDataFrame", formula = "formula"),
#'
\url{https://stat.ethz.ch/R-manual/R-devel/library/stats/html/family.html}.
#' @param epsilon Positive convergence tolerance of iterations.
#' @param maxit Integer giving the maximal number of IRLS iterations.
-#' @return a fitted generalized linear model
+#' @return \code{spark.glm} returns a fitted generalized linear model.
#' @rdname glm
#' @export
-#' @examples
-#' \dontrun{
-#' sparkR.session()
-#' data(iris)
-#' df <- createDataFrame(iris)
-#' model <- glm(Sepal_Length ~ Sepal_Width, df, family = "gaussian")
-#' summary(model)
-#' }
#' @note glm since 1.5.0
setMethod("glm", signature(formula = "formula", family = "ANY", data =
"SparkDataFrame"),
function(formula, family = gaussian, data, epsilon = 1e-6, maxit
= 25) {
spark.glm(data, formula, family, tol = epsilon, maxIter =
maxit)
})
-#' Get the summary of a generalized linear model
-#'
-#' Returns the summary of a model produced by glm() or spark.glm(),
similarly to R's summary().
-#'
+#' @title Return a summary of the produced generalized linear model
--- End diff --
This doesn't show up anywhere, does it? I think it is okay to use this
trick to document methods inline if we don't have other ways to prevent it
showing up in the description section. cc: @shivaram @felixcheung
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
