interpret-surrogate-methods: Global surrogate result methods.

interpret-surrogate-methodsR Documentation

Global surrogate result methods.

Description

These methods provide the standard print(), summary(), and plot() interfaces for funcml_surrogate objects returned by interpret(method = "surrogate").

Usage

## S3 method for class 'funcml_surrogate'
plot(x, ...)

## S3 method for class 'funcml_surrogate'
print(x, ...)

## S3 method for class 'funcml_surrogate'
summary(object, ...)

Arguments

x

A funcml_surrogate object.

...

Additional arguments passed to the underlying method.

object

A funcml_surrogate object.

Value

plot() returns a ggplot2 object. print() returns the input object invisibly. summary() returns the surrogate model summary object invisibly.

Examples

fit_obj <- fit(mpg ~ wt + hp + disp, data = mtcars, model = "rpart",
  spec = list(cp = 0.01, minsplit = 5))
surrogate <- interpret(
  fit = fit_obj,
  data = mtcars,
  method = "surrogate"
)
print(surrogate)
summary(surrogate)
plot(surrogate)

funcml documentation built on Aug. 22, 2026, 5:08 p.m.