additivityLineup: Lineup plot for additivity

View source: R/additivityLineup.R

additivityLineupR Documentation

Lineup plot for additivity

Description

This function creates a lineup plot to assess the additivity of a predictor's effect. It uses a nonparametric bootstrap approach to generate null plots.

Usage

additivityLineup(
  backfit_obj,
  fitMethod,
  realICE,
  figs = 10,
  colorvecfcn,
  usecolorvecfcn_inreal = FALSE,
  null_predictfcn,
  ...
)

Arguments

backfit_obj

An object of class backfitter.

fitMethod

A function that accepts X and y and returns a fitted model.

realICE

The ice object for the real data.

figs

The total number of plots in the lineup (including the real one). Default is 10.

colorvecfcn

Optional function to generate a color vector for the curves.

usecolorvecfcn_inreal

If TRUE, use colorvecfcn for the real plot.

null_predictfcn

Optional prediction function for the null models.

...

Additional arguments passed to plot.ice.

Value

An object of class additivityLineup (invisibly).


ICEbox documentation built on Jan. 12, 2026, 9:06 a.m.