diff options
| author | Gertjan van den Burg <gertjanvandenburg@gmail.com> | 2018-04-04 15:08:12 -0400 |
|---|---|---|
| committer | Gertjan van den Burg <gertjanvandenburg@gmail.com> | 2018-04-04 15:08:12 -0400 |
| commit | 459ce96fa8a0072d3533bc2dc1566cc1b797401b (patch) | |
| tree | 229a5d9b137f7fcf3b5112e4a189e972d6dafa26 /R/validate.R | |
| parent | Ensure classes isn't a factor (diff) | |
| download | rgensvm-459ce96fa8a0072d3533bc2dc1566cc1b797401b.tar.gz rgensvm-459ce96fa8a0072d3533bc2dc1566cc1b797401b.zip | |
Documentation improvements
Diffstat (limited to 'R/validate.R')
| -rw-r--r-- | R/validate.R | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/R/validate.R b/R/validate.R index 5960a38..c708158 100644 --- a/R/validate.R +++ b/R/validate.R @@ -1,7 +1,14 @@ #' @title [internal] Validate parameters #' +#' @description Internal function used to validate the parameters passed to the +#' gensvm() function. +#' +#' @return TRUE if all values pass their respective conditions, FALSE +#' otherwise. +#' #' @export #' @keywords internal +#' gensvm.validate.params <- function(p=NULL, kappa=NULL, lambda=NULL, epsilon=NULL, gamma=NULL, weights=NULL, kernel=NULL, ...) @@ -26,8 +33,15 @@ gensvm.validate.params <- function(p=NULL, kappa=NULL, lambda=NULL, #' @title [internal] Validate parameter grid #' +#' @description Internal function to validate all parameters in a parameter +#' grid. +#' +#' @return TRUE if all values pass their respective conditions, FALSE +#' otherwise. +#' #' @export #' @keywords internal +#' gensvm.validate.param.grid <- function(df) { expected.colnames <- c("kernel", "coef", "degree", "gamma", "weights", |