API Reference¶

A curated index of the interlace public API, grouped by task. Each entry links to the full reference page for that function or class.

Fitting¶

Function / class	Description
fit	Main entry point — LMM via profiled REML
glmer	Generalised linear mixed model (GLMM) via Laplace
clmm	Cumulative link mixed model (ordinal outcomes)
coxme	Cox proportional hazards with Gaussian frailty
ols	Ordinary least squares with HC3 robust SEs
quantreg	Quantile regression (LP-based)
Correlation structures	Residual correlation structures — `AR1`, `CompoundSymmetry`
GLMM families	GLMM family objects — Poisson, Binomial, NegBinomial, Gamma, ZI variants

Results and summaries¶

Function / class	Description
CrossedLMEResult	`CrossedLMEResult` — the object returned by `fit()`
summary and VarCorr	`summary()` — formatted coefficient table
VarCorr	`VarCorr()` — variance component table
Prediction	`predict()` — fitted values and out-of-sample predictions

Post-estimation¶

Function / class	Description
emmeans	`emmeans()` — estimated marginal means
contrast / pairs	`contrast()` — custom contrasts between marginal means
anova	`anova()` — likelihood ratio test between nested models
Anova	`Anova()` — type II / type III F-tests
anova_type2 / anova_type3	`anova_type2()` / `anova_type3()` — manual type II / III tables

Inference and uncertainty¶

Function / class	Description
Kenward-Roger degrees of freedom	Kenward-Roger denominator DFs and adjusted covariance
profile_confint	`profile_confint()` — profile likelihood confidence intervals
isSingular	`isSingular()` — boundary / convergence diagnostics
allFit	`allFit()` — refit with all optimisers and compare
cross_val	`cross_val()` — group-aware cross-validation

Diagnostics¶

Function / class	Description
Residuals	`hlm_resid()` — residuals (marginal, conditional, standardised)
Augment	`hlm_augment()` — residuals and fitted values as a DataFrame
Leverage	`leverage()` — observation-level leverage
Influence diagnostics	`hlm_influence()` — Cook’s D and DFFITS via exact deletion
lmer_influence_measures	`lmer_influence_measures()` — group-level influence
Analytical REML gradient	Analytical REML gradient utilities
Plotting	`plot_diagnostics()` — residual and QQ plots

Simulation and bootstrap¶

Function / class	Description
simulate / bootMer	`simulate()` / `bootMer()` — parametric bootstrap and power analysis