From 459ce96fa8a0072d3533bc2dc1566cc1b797401b Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Wed, 4 Apr 2018 15:08:12 -0400 Subject: Documentation improvements --- R/gensvm.train.test.split.R | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'R/gensvm.train.test.split.R') 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 -- cgit v1.2.3