GenSVM R package

1 files changed, 32 insertions, 0 deletions

diff --git a/R/coef.gensvm.grid.R b/R/coef.gensvm.grid.R
new file mode 100644
index 0000000..15e6525
--- /dev/null
+++ b/R/coef.gensvm.grid.R
@@ -0,0 +1,32 @@
+#' @title Get the parameter grid from a GenSVM Grid object
+#'
+#' @description Returns the parameter grid of a \code{gensvm.grid} object.
+#'
+#' @param object a \code{gensvm.grid} object
+#' @param \dots further arguments are ignored
+#'
+#' @return The parameter grid of the GenSVMGrid object as a data frame.
+#'
+#' @author
+#' Gerrit J.J. van den Burg, Patrick J.F. Groenen \cr
+#' Maintainer: Gerrit J.J. van den Burg <gertjanvandenburg@gmail.com>
+#'
+#' @references
+#' Van den Burg, G.J.J. and Groenen, P.J.F. (2016). \emph{GenSVM: A Generalized 
+#' Multiclass Support Vector Machine}, Journal of Machine Learning Research, 
+#' 17(225):1--42. URL \url{http://jmlr.org/papers/v17/14-526.html}.
+#'
+#' @method coef gensvm.grid
+#' @export
+#'
+#' @examples
+#' x <- iris[, -5]
+#' y <- iris[, 5]
+#'
+#' grid <- gensvm.grid(x, y)
+#' pg <- coef(grid)
+#'
+coef.gensvm.grid <- function(object, ...)
+{
+    return(object$param.grid)
+}