R/sanitize_type_arg.R

In ggeffects: Create Tidy Data Frames of Marginal Effects for 'ggplot' from Model Outputs

.sanitize_type_argument <- function(model, type = NULL, verbose = TRUE) {
  # do nothing here...
  if (is.null(type) || is.null(model)) {
    return(NULL)
  }

  # do nothing for unrecognized model classes
  model_class <- class(model)[1]
  if (!model_class %in% .typedic$class) {
    return(type)
  }

  # if "type" is no valid type, return most common valid type
  valid_types <- .typedic$type[.typedic$class == model_class]
  if (!type %in% valid_types) {
    if (verbose) {
      insight::format_alert(
        paste0(
          "\"", type, "\" is no valid option for the `scale` argument.",
          " Changing to the supported \"", valid_types[1], "\"-type now."
        )
      )
    }
    return(valid_types[1])
  }

  # we have a valid type here
  return(type)
}


.typedic <- data.frame(class = c(
  "other", "other", "other", "bam", "bam",
  "betareg", "betareg", "betareg", "betareg", "betareg", "bife",
  "bife", "bracl", "brglmFit", "brglmFit", "brmsfit", "brmsfit",
  "brmsfit", "brmsfit", "brmultinom", "brmultinom", "clm", "clm",
  "clm", "clogit", "clogit", "clogit", "clogit", "coxph", "coxph",
  "coxph", "coxph", "crch", "crch", "crch", "crch", "hetprob",
  "hetprob", "hxlr", "hxlr", "hxlr", "hxlr", "ivpml", "ivpml",
  "fixest", "fixest", "hurdle", "hurdle", "hurdle", "hurdle", "iv_robust",
  "lm", "gam", "gam", "Gam", "Gam", "geeglm", "geeglm", "glimML",
  "glimML", "glm", "glm", "glmerMod", "glmerMod", "glmrob", "glmrob",
  "glmmTMB", "glmmTMB", "glmmTMB", "glmmTMB", "glmmTMB", "glmmTMB",
  "glmmPQL", "glmmPQL", "glmx", "ivreg", "lmerMod", "lmerModLmerTest",
  "lmrob", "lm_robust", "lrm", "lrm", "lrm", "mblogit", "mblogit",
  "mblogit", "mclogit", "mclogit", "mclogit", "MCMCglmm", "multinom",
  "multinom", "mhurdle", "mhurdle", "mhurdle", "mlogit", "negbin",
  "negbin", "ols", "orm", "orm", "orm", "polr", "rlm", "selection",
  "selection", "selection", "speedlm", "speedglm", "speedglm",
  "stanreg", "stanreg", "svyglm", "svyglm", "tobit", "tobit1",
  "tobit1", "tobit1", "zeroinfl", "zeroinfl", "zeroinfl", "zeroinfl"
), type = c(
  "response", "class", "link", "response", "link",
  "response", "link", "precision", "quantile", "variance", "response",
  "link", "probs", "response", "link", "response", "link", "prediction",
  "average", "probs", "class", "prob", "cum.prob", "linear.predictor",
  "expected", "lp", "risk", "survival", "expected", "lp", "risk",
  "survival", "response", "location", "scale", "density", "pr",
  "xb", "location", "cumprob", "scale", "density", "pr", "xb",
  "response", "link", "response", "prob", "count", "zero", "response",
  "response", "response", "link", "response", "link", "response",
  "link", "response", "link", "response", "link", "response", "link",
  "response", "link", "response", "link", "conditional", "zprob",
  "zlink", "disp", "response", "link", "response", "response",
  "response", "response", "response", "response", "fitted", "lp",
  "mean", "response", "latent", "link", "response", "latent", "link",
  "response", "probs", "latent", "E", "Ep", "p", "response", "response",
  "link", "lp", "fitted", "mean", "lp", "probs", "response", "response",
  "link", "unconditional", "response", "response", "link", "response",
  "link", "response", "link", "response", "expvalue", "linpred",
  "prob", "response", "prob", "count", "zero"
), stringsAsFactors = FALSE)