From 752213150fa99cec45f8e1e588314377e31edd43 Mon Sep 17 00:00:00 2001 From: maksymiuks <32574056+maksymiuks@users.noreply.github.com> Date: Wed, 4 Sep 2024 10:56:53 +0200 Subject: [PATCH] Update documentation --- DESCRIPTION | 2 +- R/plot_model_performance.R | 3 +++ man/plot.model_performance.Rd | 3 +++ 3 files changed, 7 insertions(+), 1 deletion(-) diff --git a/DESCRIPTION b/DESCRIPTION index 9cac582fe..69ed6e782 100644 --- 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 index 05433f912..8286e6cba 100644 --- 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 index f6e063a22..820e9c372 100644 --- a/man/plot.model_performance.Rd +++ b/man/plot.model_performance.Rd @@ -35,6 +35,9 @@ An object of the class \code{model_performance}. \description{ Plot Dataset Level Model Performance Explanations } +\details{ +Whenever multiple explainers are provided using ellipsis, they are sorted based on their labels levels. +} \examples{ \donttest{ library("ranger")