aboutsummaryrefslogtreecommitdiff
path: root/R/gensvm.train.test.split.R
diff options
context:
space:
mode:
Diffstat (limited to 'R/gensvm.train.test.split.R')
-rw-r--r--R/gensvm.train.test.split.R6
1 files changed, 6 insertions, 0 deletions
diff --git a/R/gensvm.train.test.split.R b/R/gensvm.train.test.split.R
index eca4b06..cd40ecc 100644
--- a/R/gensvm.train.test.split.R
+++ b/R/gensvm.train.test.split.R
@@ -18,6 +18,12 @@
#' of 0.25 will be used.
#' @param shuffle shuffle the rows or not
#' @param random.state seed for the random number generator (int)
+#' @param return.idx whether or not to return the indices in the output
+#'
+#' @return a list with \code{x.train} and \code{x.test} splits of the \code{x}
+#' array provided. If \code{y} is provided, also \code{y.train} and
+#' \code{y.test}. If \code{return.idx} is TRUE, also \code{idx.train} and
+#' \code{idx.test}.
#'
#' @author
#' Gerrit J.J. van den Burg, Patrick J.F. Groenen \cr