GenSVM R package

1 files changed, 61 insertions, 0 deletions

diff --git a/R/print.gensvm.grid.R b/R/print.gensvm.grid.R
new file mode 100644
index 0000000..88967d7
--- /dev/null
+++ b/R/print.gensvm.grid.R
@@ -0,0 +1,61 @@
+#' @title Print the fitted GenSVMGrid model
+#'
+#' @description Prints the summary of the fitted GenSVMGrid model
+#'
+#' @param grid a \code{gensvm.grid} object to print
+#' @param \dots further arguments are ignored
+#'
+#' @return returns the object passed as input
+#'
+#' @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 print gensvm.grid
+#' @export
+#'
+#' @examples
+#' x <- iris[, -5]
+#' y <- iris[, 5]
+#'
+#' # fit a grid search and print the resulting object
+#' grid <- gensvm.grid(x, y)
+#' print(grid)
+#'
+print.gensvm.grid <- function(grid, ...)
+{
+    cat("Data:\n")
+    cat("\tn.objects:", grid$n.objects, "\n")
+    cat("\tn.features:", grid$n.features, "\n")
+    cat("\tn.classes:", grid$n.classes, "\n")
+    if (is.factor(grid$classes))
+        cat("\tclasses:", levels(grid$classes), "\n")
+    else
+        cat("\tclasses:", grid$classes, "\n")
+    cat("Config:\n")
+    cat("\tNumber of cv splits:", grid$n.splits, "\n")
+    not.run <- sum(is.na(grid$cv.results$rank.test.score))
+    if (not.run > 0) {
+        cat("\tParameter grid size:", dim(grid$param.grid)[1])
+        cat(" (", not.run, " incomplete)", sep="")
+        cat("\n")
+    } else {
+        cat("\tParameter grid size:", dim(grid$param.grid)[1], "\n")
+    }
+    cat("Results:\n")
+    cat("\tTotal grid search time:", grid$total.time, "\n")
+    if (!is.na(grid$best.index)) {
+        best <- grid$cv.results[grid$best.index, ]
+        cat("\tBest mean test score:", best$mean.test.score, "\n")
+        cat("\tBest mean fit time:", best$mean.fit.time, "\n")
+        for (name in colnames(grid$best.params))
+            cat("\tBest parameter", name, "=", grid$best.params[[name]], "\n")
+    }
+
+    invisible(grid)
+}