summary.mfpi: Summarize an '"mfpi"' Object

View source: R/mfpi_summary.R

summary.mfpiR Documentation

Summarize an "mfpi" Object

Description

Produces a structured summary of an "mfpi" fit.

Usage

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

Arguments

object

An object of class "mfpi".

...

Currently unused.

Details

The printed summary has four steps. Steps 1–3 are the same model-building display produced by print.mfpi(): the selected adjustment model, all interaction candidates, and the final interaction-selection summary. Step 4 reports regression results for retained interaction models using MFPI-specific labels rather than the raw output of the underlying regression model.

The main MFPI header reports the FLEX setting, while Step 2 reports the grouping variable and interaction-selection settings. Step 4 avoids repeating those fit-level properties within each retained model. Instead, each retained interaction is introduced by an underlined interaction heading and reports its FP form and interaction powers for every group level. Regression coefficients are then separated into:

  1. group-specific FP terms, displayed using the original group labels and readable FP transformations;

  2. group-variable coefficients, with the fitted reference level stated explicitly;

  3. a model intercept when the underlying model contains one; and

  4. adjustment coefficients.

Centered basis terms report their stored centering constants using the same Basis - Center convention as print.mfp2(). Multinomial models use one outcome-versus-reference block per non-reference outcome, retaining the same coefficient-table separation within every block. Each coefficient table includes the estimate, standard error, model-specific test statistic (for example, z or t), and p-value. Significance stars, exponentiated coefficients, confidence-interval tables, the raw model call, and model-level likelihood-ratio/Wald/score tests are intentionally not printed. In particular, the usual global model tests condition on the selected regression specification and their standard degrees of freedom do not represent the additional model-selection complexity introduced by FP power selection.

Group-variable coefficients are coefficients of the fitted regression parameterization. When a group-by-continuous interaction is present, they are not overall comparisons between group levels; group comparisons depend on the interacting variable and should be obtained from predict.mfpi().

Coefficient-level p-values are also conditional on the selected functional forms and do not account for uncertainty introduced by adjustment-model, FP, or interaction selection. They should therefore not be used for the MFPI interaction decision. The criterion reported in Step 3 is the relevant MFPI selection result.

Value

An object of class "summary.mfpi". In addition to the fields needed to reproduce the MFPI Steps 1–3 display, the object contains regression_displays, a named list of structured coefficient displays for retained interaction models. Each display contains readable coefficient metadata, the corresponding model-conditional coefficient statistics, and model-specific nuisance metadata. Retained negative-binomial models report their own theta, while retained survreg models report their own scale(s). The normalized family_string is retained. Multinomial summaries also retain class_levels, reference_class, and n_logits; ordinal summaries retain ordinal_levels, ordinal_link, and n_intercepts. Printing the object produces the four-step summary described above.

See Also

mfpi(), print.mfpi(), coef.mfpi(), vcov.mfpi(), predict.mfpi(), plot.mfpi()

Examples


data("prostate", package = "mfp2")

fit <- mfpi(
  lpsa ~ fp(age) + svi + fp(cavol),
  data = prostate,
  group_var = "svi",
  interaction_vars = "cavol",
  interaction_forms = c(cavol = "fp2"),
  flex = "flex4",
  p_interact = 1,
  verbose = FALSE
)

summary(fit)



mfp2 documentation built on Nov. 14, 2026, 1:06 a.m.