print.cat_initialization {catalytic}R Documentation

Print Summary for Catalytic Initialization Model

Description

This function provides a comprehensive summary of a catalytic initialization model object (cat_init), including formula details, data dimensions, and sample data previews.

Usage

## S3 method for class 'cat_initialization'
print(x, show_data = TRUE, detail = TRUE, ...)

Arguments

x

A catalytic initialization model object containing formula, family, data dimensions, and sampling details.

show_data

Logical, default TRUE. If TRUE, previews the head of both observation and synthetic data (up to the first 10 columns).

detail

Logical, default TRUE. If TRUE, adds guidance for interpreting the output.

...

Additional parameters to pass to other functions.

Details

The function provides a detailed overview of the initialization process for the cat_initialization model, including:

The show_data parameter controls whether the first few rows of the data are printed, while the detail parameter controls whether additional help for interpreting the printed output is displayed.

Value

Invisibly returns the x object.


[Package catalytic version 0.1.0 Index]