summary.savvyPR: Summary of Parity Regression Model

View source: R/summary.savvyPR.R

summary.savvyPRR Documentation

Summary of Parity Regression Model

Description

Prints a comprehensive statistical summary of a fitted parity regression model object. It displays the model's configuration, statistical summaries of the estimated coefficients, and overall model fit statistics.

Usage

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

Arguments

object

A fitted model object of class savvyPR returned by savvyPR.

...

Additional arguments passed to the generic summary function (currently unused).

Details

Summary of a Fitted Parity Regression Model with Statistics

This function is an S3 method for the generic summary function. It formats and prints a detailed statistical overview of the fitted model. The output includes:

  • The parameterization method used ("budget" or "target").

  • The matched call that produced the model.

  • Residual quantiles.

  • A table of estimated coefficients with their corresponding standard errors, t-values, p-values, confidence intervals, and significance codes.

  • Overall model fit statistics, including Residual Standard Error, Multiple and Adjusted R-squared, F-statistic, AIC, BIC, and Deviance.

Value

Invisibly returns NULL. This function is primarily called for its side effect of printing the summary to the console.

Author(s)

Ziwei Chen, Vali Asimit and Pietro Millossovich
Maintainer: Ziwei Chen <ziwei.chen.3@citystgeorges.ac.uk>

See Also

savvyPR

Examples

# Simulate some data
set.seed(123)
n <- 100
p <- 10
x <- matrix(rnorm(n * p), n, p)
beta <- matrix(rnorm(p), p, 1)
y <- x %*% beta + rnorm(n, sd = 0.5)

# Example 1: Fit and summarize a Budget-based parity regression model
fit_budget <- savvyPR(x, y, method = "budget", val = 0.05, intercept = FALSE)
summary(fit_budget)

# Example 2: Fit and summarize a Target-based parity regression model
fit_target <- savvyPR(x, y, method = "target", val = 1, intercept = TRUE)
summary(fit_target)


savvyPR documentation built on April 7, 2026, 5:08 p.m.