Update documentation

ModelOriented · Sep 4, 2024 · 7522131 · 7522131
1 parent d49cdc0
commit 7522131
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 1 deletion.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -22,7 +22,7 @@ Description: Any unverified black box model is the path to failure. Opaqueness l
 License: GPL
 Encoding: UTF-8
 LazyData: true
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.2
 Depends: R (>= 3.5)
 Imports: 
   ggplot2,

diff --git a/R/plot_model_performance.R b/R/plot_model_performance.R
@@ -8,6 +8,9 @@
 #' @param show_outliers number of largest residuals to be presented (only when geom = boxplot).
 #' @param ptlabel either \code{"name"} or \code{"index"} determines the naming convention of the outliers
 #'
+#' @details
+#' Whenever multiple explainers are provided using ellipsis, they are sorted based on their labels levels.
+#' 
 #' @return An object of the class \code{model_performance}.
 #'
 #' @export

diff --git a/man/plot.model_performance.Rd b/man/plot.model_performance.Rd