Helper functions for predict_parts.R

Source: R/surv_shap.R

Helper functions for predict_parts.R

surv_shap(
  explainer,
  new_observation,
  output_type,
  ...,
  N = NULL,
  y_true = NULL,
  calculation_method = c("kernelshap", "exact_kernel", "treeshap"),
  aggregation_method = c("integral", "mean_absolute", "max_absolute", "sum_of_squares")
)

Arguments

explainer

an explainer object - model preprocessed by the explain() function

new_observation

new observations for which predictions need to be explained

output_type

a character, either "survival" or "chf". Determines which type of prediction should be used for explanations.

...

additional parameters, passed to internal functions

N

a positive integer, number of observations used as the background data

y_true

a two element numeric vector or matrix of one row and two columns, the first element being the true observed time and the second the status of the observation, used for plotting

calculation_method

a character, either "kernelshap" for use of kernelshap library (providing faster Kernel SHAP with refinements), "exact_kernel" for exact Kernel SHAP estimation, or "treeshap" for use of treeshap library (efficient implementation to compute SHAP values for tree-based models).

aggregation_method

a character, either "integral", "integral_absolute", "mean_absolute", "max_absolute", or "sum_of_squares"

Value

A list, containing the calculated SurvSHAP(t) results in the result field

References