R/param_cal_method.R

In tidymodels/dials: Tools for Creating Tuning Parameter Values

#' Methods for model calibration
#' @param values A character string of possible values. See `values_cal_cls`
#'  and `values_cal_reg` (in examples below).
#'
#' @details
#' This parameter is used in postprocessing methods in the tailor package.
#'
#' @examples
#' values_cal_cls
#' cal_method_class()
#'
#' values_cal_reg
#' cal_method_reg()
#' @rdname calibration
#' @export
cal_method_class <- function(values = values_cal_cls) {
  new_qual_param(
    type = "character",
    values = values,
    label = c(cal_method_class = "Calibration Method"),
    finalize = NULL
  )
}

#' @rdname calibration
#' @export
cal_method_reg <- function(values = values_cal_reg) {
  new_qual_param(
    type = "character",
    values = values,
    label = c(cal_method_reg = "Calibration Method"),
    finalize = NULL
  )
}

#' @rdname calibration
#' @export
values_cal_cls <- c(
  "logistic_spline",
  "logistic",
  "beta",
  "isotonic",
  "isotonic_boot",
  "none"
)

#' @rdname calibration
#' @export
values_cal_reg <- c(
  "linear_spline",
  "linear",
  "isotonic",
  "isotonic_boot",
  "none"
)