improving doc, examples and adding NEWS

fix #260

DESCRIPTION

@@ -86,4 +86,4 @@ Encoding: UTF-8
 Language: en-US
 LazyData: true
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.1
+RoxygenNote: 7.3.2

NEWS.md

@@ -19,6 +19,8 @@
 
 **Fixes**
 
+- `tidy_multgee()` has been fixed to properly identify the different `y.levels`
+  (#260 @jackmwolf)
 - `tidy_marginal_predictions()` has been updated to avoid the use of the
   deprecated function `marginaleffects::datagridcf()` (#256)
 

R/custom_tidiers.R

@@ -258,15 +258,25 @@ tidy_broom <- function(x, ...) {
 #' interval in the tidied output
 #' @param conf.level the confidence level to use for the confidence interval
 #' @param ... additional parameters passed to `parameters::model_parameters()`
+#' @details
+#' To be noted, for `multgee::nomLORgee()`, the baseline `y` category is the
+#' latest modality of `y`.
+#'
 #' @export
 #' @family custom_tieders
 #' @examplesIf interactive()
 #' if (.assert_package("multgee", boolean = TRUE)) {
 #'   library(multgee)
 #'
+#'   h <- housing
+#'   h$status <- factor(
+#'     h$y,
+#'     labels = c("street", "community", "independant")
+#'   )
+#'
 #'   mod <- multgee::nomLORgee(
-#'     y ~ factor(time) * sec,
-#'     data = multgee::housing,
+#'     status ~ factor(time) * sec,
+#'     data = h,
 #'     id = id,
 #'     repeated = time,
 #'   )

tests/testthat/test-tidy_plus_plus.R

@@ -715,9 +715,14 @@ test_that("tidy_plus_plus() works with multgee models", {
   skip_if_not_installed("parameters")
 
   library(multgee)
+  h <- housing
+  h$status <- factor(
+    h$y,
+    labels = c("street", "community", "independant")
+  )
   mod <- multgee::nomLORgee(
-    y ~ factor(time) * sec,
-    data = multgee::housing,
+    status ~ factor(time) * sec,
+    data = h,
     id = id,
     repeated = time,
   )
@@ -728,8 +733,9 @@ test_that("tidy_plus_plus() works with multgee models", {
   expect_equivalent(
     res$y.level,
     c(
-      "0", "0", "0", "0", "0", "0", "0", "0",
-      "1", "1", "1", "1", "1", "1", "1", "1"
+      "street", "street", "street", "street", "street", "street",
+      "street", "street", "community", "community", "community", "community",
+      "community", "community", "community", "community"
     )
   )
   expect_equivalent(