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/validate.R | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'R/validate.R') 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", -- cgit v1.2.3