Package index • ClockSHAP

Clock and reference specification

Define the linear clock and the age-conditioned reference.

linear_clock(): Create a linear aging clock
reference_profile(): Create a reference age-feature profile
fit_reference_profile(): Fit per-feature linear models of feature values versus age to obtain a reference_profile.

Running ClockSHAP

Compute the age-matched deviation and its per-feature decomposition.

clockshap(): ClockSHAP decomposition

Accessors

Pull individual components out of a clockshap object.

clockshap_predicted(): Extract ClockSHAP predicted ages
clockshap_expected(): Extract ClockSHAP expected ages
clockshap_deviation(): Extract ClockSHAP deviation values
clockshap_phi(): Extract ClockSHAP feature contributions

Visualization

plot_clockshap_waterfall(): Plot ClockSHAP waterfall for a single sample
clockshap_waterfall_values(): Compute reconciled values for a ClockSHAP waterfall

Example data

clockshap_example: Synthetic ClockSHAP example dataset