print.cat: Print Method for 'cat' Object

View source: R/prints.R

print.catR Documentation

Print Method for cat Object

Description

The print.cat function provides a detailed summary of the cat object, displaying key information about the model and its settings, including model type, covariates, formula, tau values, and relevant coefficients.

Usage

## S3 method for class 'cat'
print(x, digit = 3, detail = TRUE, ...)

Arguments

x

An object of class cat, representing a fitted model.

digit

An integer indicating the number of decimal places for printing coefficient estimates. Default is 3.

detail

A logical indicating whether to print additional details for interpreting the output. Default is TRUE.

...

Additional parameters to pass to other functions.

Details

This function customizes the output based on the model type stored within the x object, such as GLM, Cox, or other types of models.

The print.cat function prints a summary of the model stored in the x object. It will display different information depending on the model's type (GLM, Cox, etc.). It will show:

  • The model's function name.

  • The dimensions of the covariates used in the model.

  • The tau values.

  • Model-specific details such as family for GLMs or method and iteration info for Cox models.

  • Coefficients related to the model.

Value

The x object is returned invisibly.


catalytic documentation built on April 4, 2025, 5:51 a.m.