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 --- man/gensvm.train.test.split.Rd | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'man/gensvm.train.test.split.Rd') diff --git a/man/gensvm.train.test.split.Rd b/man/gensvm.train.test.split.Rd index fe2b1fb..261f7d1 100644 --- a/man/gensvm.train.test.split.Rd +++ b/man/gensvm.train.test.split.Rd @@ -27,6 +27,14 @@ of 0.25 will be used.} \item{shuffle}{shuffle the rows or not} \item{random.state}{seed for the random number generator (int)} + +\item{return.idx}{whether or not to return the indices in the output} +} +\value{ +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}. } \description{ Often it is desirable to split a dataset into a training and -- cgit v1.2.3