aboutsummaryrefslogtreecommitdiff
path: root/R/pkg
diff options
context:
space:
mode:
authorFelix Cheung <felixcheung_m@hotmail.com>2016-08-24 15:59:09 -0700
committerFelix Cheung <felixcheung@apache.org>2016-08-24 15:59:09 -0700
commit945c04bcd439e0624232c040df529f12bcc05e13 (patch)
tree8ec2437c971bed972c2b2bdeacf8ae9413d5e307 /R/pkg
parent29952ed096fd2a0a19079933ff691671d6f00835 (diff)
downloadspark-945c04bcd439e0624232c040df529f12bcc05e13.tar.gz
spark-945c04bcd439e0624232c040df529f12bcc05e13.tar.bz2
spark-945c04bcd439e0624232c040df529f12bcc05e13.zip
[MINOR][SPARKR] fix R MLlib parameter documentation
## What changes were proposed in this pull request? Fixed several misplaced param tag - they should be on the spark.* method generics ## How was this patch tested? run knitr junyangq Author: Felix Cheung <felixcheung_m@hotmail.com> Closes #14792 from felixcheung/rdocmllib.
Diffstat (limited to 'R/pkg')
-rw-r--r--R/pkg/R/mllib.R4
1 files changed, 2 insertions, 2 deletions
diff --git a/R/pkg/R/mllib.R b/R/pkg/R/mllib.R
index a670600ca6..dfc5a1c7df 100644
--- a/R/pkg/R/mllib.R
+++ b/R/pkg/R/mllib.R
@@ -444,6 +444,7 @@ setMethod("write.ml", signature(object = "LDAModel", path = "character"),
#' @param featureIndex The index of the feature if \code{featuresCol} is a vector column
#' (default: 0), no effect otherwise
#' @param weightCol The weight column name.
+#' @param ... additional arguments passed to the method.
#' @return \code{spark.isoreg} returns a fitted Isotonic Regression model
#' @rdname spark.isoreg
#' @aliases spark.isoreg,SparkDataFrame,formula-method
@@ -504,7 +505,6 @@ setMethod("predict", signature(object = "IsotonicRegressionModel"),
# Get the summary of an IsotonicRegressionModel model
-#' @param ... Other optional arguments to summary of an IsotonicRegressionModel
#' @return \code{summary} returns the model's boundaries and prediction as lists
#' @rdname spark.isoreg
#' @aliases summary,IsotonicRegressionModel-method
@@ -1074,6 +1074,7 @@ setMethod("predict", signature(object = "AFTSurvivalRegressionModel"),
#' @param k number of independent Gaussians in the mixture model.
#' @param maxIter maximum iteration number.
#' @param tol the convergence tolerance.
+#' @param ... additional arguments passed to the method.
#' @aliases spark.gaussianMixture,SparkDataFrame,formula-method
#' @return \code{spark.gaussianMixture} returns a fitted multivariate gaussian mixture model.
#' @rdname spark.gaussianMixture
@@ -1117,7 +1118,6 @@ setMethod("spark.gaussianMixture", signature(data = "SparkDataFrame", formula =
# Get the summary of a multivariate gaussian mixture model
#' @param object a fitted gaussian mixture model.
-#' @param ... currently not used argument(s) passed to the method.
#' @return \code{summary} returns the model's lambda, mu, sigma and posterior.
#' @aliases spark.gaussianMixture,SparkDataFrame,formula-method
#' @rdname spark.gaussianMixture