Correct docs, update roxygen

5 files changed, 18 insertions, 11 deletions

diff --git a/DESCRIPTION b/DESCRIPTION
index 422bce7..e15dd45 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -26,5 +26,5 @@ Classification/MSC: 62H30, 68T10
 URL: https://github.com/GjjvdBurg/RGenSVM
      http://jmlr.org/papers/v17/14-526.html
 BugReports: https://github.com/GjjvdBurg/RGenSVM
-RoxygenNote: 6.0.1
+RoxygenNote: 6.1.1
 NeedsCompilation: yes
diff --git a/R/gensvm.grid.R b/R/gensvm.grid.R
index e76e17e..8006b87 100644
--- a/R/gensvm.grid.R
+++ b/R/gensvm.grid.R
@@ -105,8 +105,11 @@
 #' be the same as the param.grid in the input.
 #'
 #' @note
-#' This function returns partial results when the computation is interrupted by 
-#' the user.
+#' 1. This function returns partial results when the computation is interrupted 
+#' by the user.
+#' 2. The score.time reported in the results only covers the time needed to 
+#' compute the score from the predictions and true class labels. It does not 
+#' include the time to compute the predictions themselves.
 #'
 #' @author
 #' Gerrit J.J. van den Burg, Patrick J.F. Groenen \cr
@@ -332,9 +335,9 @@ gensvm.load.full.grid <- function()
 }
 
 
-#' @title Load the default parameter grid for the GenSVM grid search
+#' @title Load the small parameter grid for the GenSVM grid search
 #'
-#' @description This function loads a default parameter grid to use for the 
+#' @description This function loads a small parameter grid to use for the 
 #' GenSVM gridsearch. It contains all possible combinations of the following 
 #' parameter sets:
 #'
diff --git a/man/gensvm.grid.Rd b/man/gensvm.grid.Rd
index 6ce9ffe..0d15f9a 100644
--- a/man/gensvm.grid.Rd
+++ b/man/gensvm.grid.Rd
@@ -65,8 +65,11 @@ starts to speed up computation. The function uses the GenSVM C library for
 speed.
 }
 \note{
-This function returns partial results when the computation is interrupted by 
-the user.
+1. This function returns partial results when the computation is interrupted 
+by the user.
+2. The score.time reported in the results only covers the time needed to 
+compute the score from the predictions and true class labels. It does not 
+include the time to compute the predictions themselves.
 }
 \section{Using a Parameter Grid}{
 
diff --git a/man/gensvm.load.small.grid.Rd b/man/gensvm.load.small.grid.Rd
index ac82084..61c545c 100644
--- a/man/gensvm.load.small.grid.Rd
+++ b/man/gensvm.load.small.grid.Rd
@@ -2,12 +2,12 @@
 % Please edit documentation in R/gensvm.grid.R
 \name{gensvm.load.small.grid}
 \alias{gensvm.load.small.grid}
-\title{Load the default parameter grid for the GenSVM grid search}
+\title{Load the small parameter grid for the GenSVM grid search}
 \usage{
 gensvm.load.small.grid()
 }
 \description{
-This function loads a default parameter grid to use for the 
+This function loads a small parameter grid to use for the 
 GenSVM gridsearch. It contains all possible combinations of the following 
 parameter sets:
 
diff --git a/man/gensvm.train.test.split.Rd b/man/gensvm.train.test.split.Rd
index 261f7d1..2a38099 100644
--- a/man/gensvm.train.test.split.Rd
+++ b/man/gensvm.train.test.split.Rd
@@ -4,8 +4,9 @@
 \alias{gensvm.train.test.split}
 \title{Create a train/test split of a dataset}
 \usage{
-gensvm.train.test.split(x, y = NULL, train.size = NULL, test.size = NULL,
-  shuffle = TRUE, random.state = NULL, return.idx = FALSE)
+gensvm.train.test.split(x, y = NULL, train.size = NULL,
+  test.size = NULL, shuffle = TRUE, random.state = NULL,
+  return.idx = FALSE)
 }
 \arguments{
 \item{x}{array to split}