summary.ipd: Summarize IPD Fit

View source: R/methods.R

summary.ipdR Documentation

Summarize IPD Fit

Description

Produces a summary of the IPD method/model combination.

Usage

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

Arguments

object

An object of class ipd.

...

Additional arguments to be passed to the summary function.

Value

A list containing:

coefficients

Model coefficients and related statistics.

performance

Performance metrics of the model fit.

...

Additional summary information.

Examples


#-- Generate Example Data

set.seed(2023)

dat <- simdat(n = c(300, 300, 300), effect = 1, sigma_Y = 1)

head(dat)

formula <- Y - f ~ X1

#-- Fit IPD

fit <- ipd(formula, method = "postpi_analytic", model = "ols",

  data = dat, label = "set_label")

#-- Summarize Output

summ_fit <- summary(fit)

summ_fit


ipd documentation built on April 4, 2025, 4:41 a.m.