aboutsummaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorGertjan van den Burg <gertjanvandenburg@gmail.com>2020-09-04 17:26:50 +0100
committerGertjan van den Burg <gertjanvandenburg@gmail.com>2020-09-04 17:26:50 +0100
commit7332d3a6dfcef736e3ac4ef69591001dde5bf064 (patch)
treea46fd318143ddb96c05e17850b9590969c356de4 /man
parentFix formatting (diff)
downloadrgensvm-7332d3a6dfcef736e3ac4ef69591001dde5bf064.tar.gz
rgensvm-7332d3a6dfcef736e3ac4ef69591001dde5bf064.zip
Generate man with updated roxygen
Diffstat (limited to 'man')
-rw-r--r--man/gensvm.Rd22
-rw-r--r--man/gensvm.grid.Rd12
-rw-r--r--man/gensvm.refit.Rd22
-rw-r--r--man/gensvm.train.test.split.Rd12
-rw-r--r--man/gensvm.validate.params.Rd12
-rw-r--r--man/plot.gensvm.Rd15
6 files changed, 77 insertions, 18 deletions
diff --git a/man/gensvm.Rd b/man/gensvm.Rd
index 18bcd52..9058f54 100644
--- a/man/gensvm.Rd
+++ b/man/gensvm.Rd
@@ -4,10 +4,24 @@
\alias{gensvm}
\title{Fit the GenSVM model}
\usage{
-gensvm(x, y, p = 1, lambda = 1e-08, kappa = 0, epsilon = 1e-06,
- weights = "unit", kernel = "linear", gamma = "auto", coef = 1,
- degree = 2, kernel.eigen.cutoff = 1e-08, verbose = FALSE,
- random.seed = NULL, max.iter = 1e+08, seed.V = NULL)
+gensvm(
+ x,
+ y,
+ p = 1,
+ lambda = 1e-08,
+ kappa = 0,
+ epsilon = 1e-06,
+ weights = "unit",
+ kernel = "linear",
+ gamma = "auto",
+ coef = 1,
+ degree = 2,
+ kernel.eigen.cutoff = 1e-08,
+ verbose = FALSE,
+ random.seed = NULL,
+ max.iter = 1e+08,
+ seed.V = NULL
+)
}
\arguments{
\item{x}{data matrix with the predictors. \cr\cr
diff --git a/man/gensvm.grid.Rd b/man/gensvm.grid.Rd
index 0d15f9a..abcf00d 100644
--- a/man/gensvm.grid.Rd
+++ b/man/gensvm.grid.Rd
@@ -4,8 +4,16 @@
\alias{gensvm.grid}
\title{Cross-validated grid search for GenSVM}
\usage{
-gensvm.grid(x, y, param.grid = "tiny", refit = TRUE, scoring = NULL,
- cv = 3, verbose = 0, return.train.score = TRUE)
+gensvm.grid(
+ x,
+ y,
+ param.grid = "tiny",
+ refit = TRUE,
+ scoring = NULL,
+ cv = 3,
+ verbose = 0,
+ return.train.score = TRUE
+)
}
\arguments{
\item{x}{training data matrix. We denote the size of this matrix by
diff --git a/man/gensvm.refit.Rd b/man/gensvm.refit.Rd
index 07af08f..d5086c3 100644
--- a/man/gensvm.refit.Rd
+++ b/man/gensvm.refit.Rd
@@ -4,10 +4,24 @@
\alias{gensvm.refit}
\title{Train an already fitted model on new data}
\usage{
-gensvm.refit(fit, x, y, p = NULL, lambda = NULL, kappa = NULL,
- epsilon = NULL, weights = NULL, kernel = NULL, gamma = NULL,
- coef = NULL, degree = NULL, kernel.eigen.cutoff = NULL,
- max.iter = NULL, verbose = NULL, random.seed = NULL)
+gensvm.refit(
+ fit,
+ x,
+ y,
+ p = NULL,
+ lambda = NULL,
+ kappa = NULL,
+ epsilon = NULL,
+ weights = NULL,
+ kernel = NULL,
+ gamma = NULL,
+ coef = NULL,
+ degree = NULL,
+ kernel.eigen.cutoff = NULL,
+ max.iter = NULL,
+ verbose = NULL,
+ random.seed = NULL
+)
}
\arguments{
\item{fit}{Fitted \code{gensvm} object}
diff --git a/man/gensvm.train.test.split.Rd b/man/gensvm.train.test.split.Rd
index 2a38099..38c0420 100644
--- a/man/gensvm.train.test.split.Rd
+++ b/man/gensvm.train.test.split.Rd
@@ -4,9 +4,15 @@
\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}
diff --git a/man/gensvm.validate.params.Rd b/man/gensvm.validate.params.Rd
index ca6ddab..4776356 100644
--- a/man/gensvm.validate.params.Rd
+++ b/man/gensvm.validate.params.Rd
@@ -4,8 +4,16 @@
\alias{gensvm.validate.params}
\title{[internal] Validate parameters}
\usage{
-gensvm.validate.params(p = NULL, kappa = NULL, lambda = NULL,
- epsilon = NULL, gamma = NULL, weights = NULL, kernel = NULL, ...)
+gensvm.validate.params(
+ p = NULL,
+ kappa = NULL,
+ lambda = NULL,
+ epsilon = NULL,
+ gamma = NULL,
+ weights = NULL,
+ kernel = NULL,
+ ...
+)
}
\value{
TRUE if all values pass their respective conditions, FALSE
diff --git a/man/plot.gensvm.Rd b/man/plot.gensvm.Rd
index dc4ca38..6f9b949 100644
--- a/man/plot.gensvm.Rd
+++ b/man/plot.gensvm.Rd
@@ -4,9 +4,18 @@
\alias{plot.gensvm}
\title{Plot the simplex space of the fitted GenSVM model}
\usage{
-\method{plot}{gensvm}(x, labels, newdata = NULL, with.margins = TRUE,
- with.shading = TRUE, with.legend = TRUE, center.plot = TRUE,
- xlim = NULL, ylim = NULL, ...)
+\method{plot}{gensvm}(
+ x,
+ labels,
+ newdata = NULL,
+ with.margins = TRUE,
+ with.shading = TRUE,
+ with.legend = TRUE,
+ center.plot = TRUE,
+ xlim = NULL,
+ ylim = NULL,
+ ...
+)
}
\arguments{
\item{x}{A fitted \code{gensvm} object}