cli_topline: Create a header topline with cli

In shapr: Prediction Explanation with Dependence-Aware Shapley Values

Create a header topline with cli

Description

Create a header topline with cli

Usage

cli_topline(verbose, testing, init_time, type, is_python)

Arguments

verbose	String vector or NULL. Specifies the verbosity (printout detail level) through one or more of strings "basic", "progress", "convergence", "shapley" and "vS_details". "basic" (default) displays basic information about the computation which is being performed, in addition to some messages about parameters being sets or checks being unavailable due to specific input. ⁠"progress⁠ displays information about where in the calculation process the function currently is. #' "convergence" displays information on how close to convergence the Shapley value estimates are (only when iterative = TRUE) . "shapley" displays intermediate Shapley value estimates and standard deviations (only when iterative = TRUE) and the final estimates. "vS_details" displays information about the v_S estimates. This is most relevant for ⁠approach %in% c("regression_separate", "regression_surrogate", "vaeac"⁠). NULL means no printout. Note that any combination of four strings can be used. E.g. verbose = c("basic", "vS_details") will display basic information + details about the v(S)-estimation process.
testing	Logical. Only use to remove random components like timing from the object output when comparing output with testthat. Defaults to FALSE.
init_time	POSIXct object. The time when the explain() function was called, as outputted by Sys.time(). Used to calculate the time it took to run the full explain call.
type	Character. Either "regular" or "forecast" corresponding to function setup() is called from, correspondingly the type of explanation that should be generated.
is_python	Logical. Indicates whether the function is called from the Python wrapper. Default is FALSE which is never changed when calling the function via explain() in R. The parameter is later used to disallow running the AICc-versions of the empirical method as that requires data based optimization, which is not supported in shaprpy.

Value

No return value (but prints header with cli unless verbose is NULL)

shapr documentation built on June 8, 2025, 10:22 a.m.