Add seealso to docs to facilitate exploration of package functions

15 files changed, 60 insertions, 13 deletions

diff --git a/R/coef.gensvm.R b/R/coef.gensvm.R
index 45eeb13..09febc2 100644
--- a/R/coef.gensvm.R
+++ b/R/coef.gensvm.R
@@ -21,6 +21,10 @@
 #' Multiclass Support Vector Machine}, Journal of Machine Learning Research, 
 #' 17(225):1--42. URL \url{http://jmlr.org/papers/v17/14-526.html}.
 #'
+#' @seealso
+#' \code{\link{gensvm}}, \code{\link{plot.gensvm}}, 
+#' \code{\link{predict.gensvm}}, \code{\link{gensvm-package}}
+#'
 #' @method coef gensvm
 #' @export
 #'
diff --git a/R/coef.gensvm.grid.R b/R/coef.gensvm.grid.R
index 15e6525..3765c32 100644
--- a/R/coef.gensvm.grid.R
+++ b/R/coef.gensvm.grid.R
@@ -16,6 +16,9 @@
 #' Multiclass Support Vector Machine}, Journal of Machine Learning Research, 
 #' 17(225):1--42. URL \url{http://jmlr.org/papers/v17/14-526.html}.
 #'
+#' @seealso
+#' \code{\link{gensvm.grid}}, \code{\link{gensvm-package}}
+#'
 #' @method coef gensvm.grid
 #' @export
 #'
diff --git a/R/gensvm-package.R b/R/gensvm-package.R
index f664577..4c27695 100644
--- a/R/gensvm-package.R
+++ b/R/gensvm-package.R
@@ -98,6 +98,9 @@
 #' Multiclass Support Vector Machine}, Journal of Machine Learning Research, 
 #' 17(225):1--42. URL \url{http://jmlr.org/papers/v17/14-526.html}.
 #'
+#' @seealso
+#' \code{\link{gensvm}}, \code{\link{gensvm.grid}}
+#'
 #' @aliases
 #' gensvm.package
 #'
diff --git a/R/gensvm.R b/R/gensvm.R
index 40930ac..32ab61b 100644
--- a/R/gensvm.R
+++ b/R/gensvm.R
@@ -75,7 +75,7 @@
 #'
 #' @seealso
 #' \code{\link{coef}}, \code{\link{print}}, \code{\link{predict}}, 
-#' \code{\link{plot}}, and \code{\link{gensvm.grid}}.
+#' \code{\link{plot}}, \code{\link{gensvm.grid}}, \code{\link{gensvm-package}}
 #'
 #' @export
 #' @useDynLib gensvm_wrapper, .registration = TRUE
diff --git a/R/gensvm.accuracy.R b/R/gensvm.accuracy.R
index dbcd3cc..9a60411 100644
--- a/R/gensvm.accuracy.R
+++ b/R/gensvm.accuracy.R
@@ -13,7 +13,8 @@
 #' 17(225):1--42. URL \url{http://jmlr.org/papers/v17/14-526.html}.
 #'
 #' @seealso
-#' \code{\link{predict.gensvm.grid}}
+#' \code{\link{predict.gensvm.grid}}, \code{\link{predict.gensvm}}, 
+#' \code{\link{gensvm-package}}
 #'
 #' @export
 #'
diff --git a/R/gensvm.grid.R b/R/gensvm.grid.R
index 2b90e57..eeeb620 100644
--- a/R/gensvm.grid.R
+++ b/R/gensvm.grid.R
@@ -118,8 +118,9 @@
 #' 17(225):1--42. URL \url{http://jmlr.org/papers/v17/14-526.html}.
 #'
 #' @seealso
-#' \code{\link{predict.gensvm.grid}}, \code{\link{print.gensvm.grid}}, and 
-#' \code{\link{gensvm}}.
+#' \code{\link{predict.gensvm.grid}}, \code{\link{print.gensvm.grid}}, 
+#' \code{\link{plot.gensvm.grid}}, \code{\link{gensvm}}, 
+#' \code{\link{gensvm-package}}
 #'
 #' @export
 #'
diff --git a/R/gensvm.maxabs.scale.R b/R/gensvm.maxabs.scale.R
index 42b0be2..47a6340 100644
--- a/R/gensvm.maxabs.scale.R
+++ b/R/gensvm.maxabs.scale.R
@@ -27,6 +27,10 @@
 #' Multiclass Support Vector Machine}, Journal of Machine Learning Research, 
 #' 17(225):1--42. URL \url{http://jmlr.org/papers/v17/14-526.html}.
 #'
+#' @seealso
+#' \code{\link{gensvm}}, \code{\link{gensvm.grid}}, 
+#' \code{\link{gensvm.train.test.split}}, \code{\link{gensvm-package}}
+#'
 #' @export
 #'
 #' @examples
diff --git a/R/gensvm.refit.R b/R/gensvm.refit.R
index c0bbf20..b7a1a15 100644
--- a/R/gensvm.refit.R
+++ b/R/gensvm.refit.R
@@ -14,8 +14,6 @@
 #'
 #' @return a new fitted \code{gensvm} model
 #'
-#' @export
-#'
 #' @author
 #' Gerrit J.J. van den Burg, Patrick J.F. Groenen \cr
 #' Maintainer: Gerrit J.J. van den Burg <gertjanvandenburg@gmail.com>
@@ -25,6 +23,11 @@
 #' Multiclass Support Vector Machine}, Journal of Machine Learning Research, 
 #' 17(225):1--42. URL \url{http://jmlr.org/papers/v17/14-526.html}.
 #'
+#' @seealso
+#' \code{\link{gensvm}}, \code{\link{gensvm-package}}
+#'
+#' @export
+#'
 #' @examples
 #' x <- iris[, -5]
 #' y <- iris[, 5]
diff --git a/R/gensvm.train.test.split.R b/R/gensvm.train.test.split.R
index 406f80e..eca4b06 100644
--- a/R/gensvm.train.test.split.R
+++ b/R/gensvm.train.test.split.R
@@ -28,6 +28,9 @@
 #' Multiclass Support Vector Machine}, Journal of Machine Learning Research, 
 #' 17(225):1--42. URL \url{http://jmlr.org/papers/v17/14-526.html}.
 #'
+#' @seealso
+#' \code{\link{gensvm}}, \code{\link{gensvm-package}}
+#'
 #' @export
 #'
 #' @examples
diff --git a/R/plot.gensvm.R b/R/plot.gensvm.R
index cbad9f0..5c560e3 100644
--- a/R/plot.gensvm.R
+++ b/R/plot.gensvm.R
@@ -33,6 +33,10 @@
 #' Multiclass Support Vector Machine}, Journal of Machine Learning Research, 
 #' 17(225):1--42. URL \url{http://jmlr.org/papers/v17/14-526.html}.
 #'
+#' @seealso
+#' \code{\link{plot.gensvm.grid}}, \code{\link{predict.gensvm}}, 
+#' \code{\link{gensvm}}, \code{\link{gensvm-package}}
+#'
 #' @method plot gensvm
 #' @export
 #'
diff --git a/R/plot.gensvm.grid.R b/R/plot.gensvm.grid.R
index da101e6..6f042e9 100644
--- a/R/plot.gensvm.grid.R
+++ b/R/plot.gensvm.grid.R
@@ -10,8 +10,6 @@
 #'
 #' @return returns the object passed as input
 #'
-#' @export
-#'
 #' @author
 #' Gerrit J.J. van den Burg, Patrick J.F. Groenen \cr
 #' Maintainer: Gerrit J.J. van den Burg <gertjanvandenburg@gmail.com>
@@ -21,6 +19,12 @@
 #' Multiclass Support Vector Machine}, Journal of Machine Learning Research, 
 #' 17(225):1--42. URL \url{http://jmlr.org/papers/v17/14-526.html}.
 #'
+#' @seealso
+#' \code{\link{plot.gensvm}}, \code{\link{gensvm.grid}}, 
+#' \code{\link{predict.gensvm.grid}}, \code{\link{gensvm-package}}
+#'
+#' @export
+#'
 #' @examples
 #' x <- iris[, -5]
 #' y <- iris[, 5]
diff --git a/R/predict.gensvm.R b/R/predict.gensvm.R
index 7e04fe4..d7540f6 100644
--- a/R/predict.gensvm.R
+++ b/R/predict.gensvm.R
@@ -11,9 +11,6 @@
 #' @return a vector of class labels, with the same type as the original class 
 #' labels.
 #'
-#' @export
-#' @aliases predict
-#'
 #' @author
 #' Gerrit J.J. van den Burg, Patrick J.F. Groenen \cr
 #' Maintainer: Gerrit J.J. van den Burg <gertjanvandenburg@gmail.com>
@@ -23,6 +20,13 @@
 #' Multiclass Support Vector Machine}, Journal of Machine Learning Research, 
 #' 17(225):1--42. URL \url{http://jmlr.org/papers/v17/14-526.html}.
 #'
+#' @seealso
+#' \code{\link{plot.gensvm}}, \code{\link{predict.gensvm.grid}}, 
+#' \code{\link{gensvm}}, \code{\link{gensvm-package}}
+#'
+#' @export
+#' @aliases predict
+#'
 #' @examples
 #' x <- iris[, -5]
 #' y <- iris[, 5]
diff --git a/R/predict.gensvm.grid.R b/R/predict.gensvm.grid.R
index 81a0207..7555368 100644
--- a/R/predict.gensvm.grid.R
+++ b/R/predict.gensvm.grid.R
@@ -15,8 +15,6 @@
 #' @return a vector of class labels, with the same type as the original class 
 #' labels provided to gensvm.grid()
 #'
-#' @export
-#'
 #' @author
 #' Gerrit J.J. van den Burg, Patrick J.F. Groenen \cr
 #' Maintainer: Gerrit J.J. van den Burg <gertjanvandenburg@gmail.com>
@@ -26,6 +24,12 @@
 #' Multiclass Support Vector Machine}, Journal of Machine Learning Research, 
 #' 17(225):1--42. URL \url{http://jmlr.org/papers/v17/14-526.html}.
 #'
+#' @seealso
+#' \code{\link{gensvm}}, \code{\link{predict.gensvm.grid}}, 
+#' \code{\link{plot.gensvm}}, \code{\link{gensvm-package}}
+#'
+#' @export
+#'
 #' @examples
 #' x <- iris[, -5]
 #' y <- iris[, 5]
diff --git a/R/print.gensvm.R b/R/print.gensvm.R
index 119b264..724806b 100644
--- a/R/print.gensvm.R
+++ b/R/print.gensvm.R
@@ -17,6 +17,10 @@
 #' Multiclass Support Vector Machine}, Journal of Machine Learning Research, 
 #' 17(225):1--42. URL \url{http://jmlr.org/papers/v17/14-526.html}.
 #'
+#' @seealso
+#' \code{\link{gensvm}}, \code{\link{predict.gensvm}}, 
+#' \code{\link{plot.gensvm}}, \code{\link{gensvm-package}}
+#'
 #' @method print gensvm
 #' @export
 #'
diff --git a/R/print.gensvm.grid.R b/R/print.gensvm.grid.R
index 88967d7..558dbd8 100644
--- a/R/print.gensvm.grid.R
+++ b/R/print.gensvm.grid.R
@@ -16,6 +16,11 @@
 #' Multiclass Support Vector Machine}, Journal of Machine Learning Research, 
 #' 17(225):1--42. URL \url{http://jmlr.org/papers/v17/14-526.html}.
 #'
+#' @seealso
+#' \code{\link{gensvm.grid}}, \code{\link{predict.gensvm.grid}}, 
+#' \code{\link{plot.gensvm.grid}}, \code{\link{gensvm.grid}}, 
+#' \code{\link{gensvm-package}}
+#'
 #' @method print gensvm.grid
 #' @export
 #'