From c1f9894e730db4a7e80ed678e72a777d6267c854 Mon Sep 17 00:00:00 2001
From: Gertjan van den Burg <gertjanvandenburg@gmail.com>
Date: Wed, 6 Mar 2019 21:51:02 -0500
Subject: Correct docs, update roxygen

---
 man/gensvm.grid.Rd             | 7 +++++--
 man/gensvm.load.small.grid.Rd  | 4 ++--
 man/gensvm.train.test.split.Rd | 5 +++--
 3 files changed, 10 insertions(+), 6 deletions(-)

(limited to 'man')

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}
-- 
cgit v1.2.3