cli_startup: Printing startup messages with cli

In shapr: Prediction Explanation with Dependence-Aware Shapley Values

Printing startup messages with cli

Description

Printing startup messages with cli

Usage

cli_startup(internal, model_class, verbose)

Arguments

internal	List. Not used directly, but passed through from explain().
model_class	String. Class of the model as a string
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. ⁠"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) 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.

Value

No return value (but prints startup messages with cli)

shapr documentation built on April 4, 2025, 12:18 a.m.