cli_iter: Printing messages in iterative procedure with cli

In shapr: Prediction Explanation with Dependence-Aware Shapley Values

Printing messages in iterative procedure with cli

Description

Printing messages in iterative procedure with cli

Usage

cli_iter(verbose, internal, iter)

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. ⁠"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.
internal	List. Not used directly, but passed through from explain().
iter	Integer. The iteration number. Only used internally.

Value

No return value (but prints iterative messages with cli)

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