Errors in using r2_kullback (#686)

Author: strengejacke

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: performance
 Title: Assessment of Regression Models Performance
-Version: 0.10.8.15
+Version: 0.10.8.16
 Authors@R: 
     c(person(given = "Daniel",
              family = "Lüdecke",

NAMESPACE

@@ -429,6 +429,8 @@ S3method(r2_coxsnell,survreg)
 S3method(r2_coxsnell,svycoxph)
 S3method(r2_coxsnell,truncreg)
 S3method(r2_efron,default)
+S3method(r2_kullback,default)
+S3method(r2_kullback,glm)
 S3method(r2_loo_posterior,BFBayesFactor)
 S3method(r2_loo_posterior,brmsfit)
 S3method(r2_loo_posterior,stanmvreg)

NEWS.md

@@ -28,6 +28,8 @@
   `check_collinearity()` and `check_outliers()` for models with non-numeric
   response variables.
 
+* `r2_kullback()` now gives an informative error for non-supported models.
+
 ## Bug fixes
 
 * Fixed issue in `binned_residuals()` for models with binary outcome, where

R/r2_kl.R

@@ -7,6 +7,7 @@
 #' @param model A generalized linear model.
 #' @param adjust Logical, if `TRUE` (the default), the adjusted R2 value is
 #'   returned.
+#' @param ... Additional arguments. Currently not used.
 #'
 #' @return A named vector with the R2 value.
 #'
@@ -19,7 +20,13 @@
 #' 77: 329-342.
 #'
 #' @export
-r2_kullback <- function(model, adjust = TRUE) {
+r2_kullback <- function(model, ...) {
+  UseMethod("r2_kullback")
+}
+
+#' @rdname r2_kullback
+#' @export
+r2_kullback.glm <- function(model, adjust = TRUE, ...) {
   if (adjust) {
     adj <- model$df.null / model$df.residual
   } else {
@@ -31,3 +38,8 @@ r2_kullback <- function(model, adjust = TRUE) {
   names(klr2) <- "Kullback-Leibler R2"
   klr2
 }
+
+#' @export
+r2_kullback.default <- function(model, ...) {
+  insight::format_error("This function only works for objects of class `glm`.")
+}

inst/WORDLIST

@@ -296,6 +296,7 @@ poisson
 preprint
 priori
 pscl
+quantreg
 quared
 quartile
 quartiles

man/r2_kullback.Rd

@@ -3,3 +3,10 @@ test_that("r2_kullback", {
   expect_equal(r2_kullback(model), c(`Kullback-Leibler R2` = 0.3834), tolerance = 1e-3)
   expect_equal(r2_kullback(model, adjust = FALSE), c(`Kullback-Leibler R2` = 0.4232), tolerance = 1e-3)
 })
+
+test_that("r2_kullback errors for non-supported", {
+  skip_if_not_installed("pscl")
+  data("bioChemists", package = "pscl")
+  model <- pscl::zeroinfl(art ~ . | 1, data = bioChemists, dist = "negbin")
+  expect_error(r2_kullback(model), regex = "This function only works")
+})