print.cat_tune: Print Method for 'cat_tune' Object

In catalytic: Tools for Applying Catalytic Priors in Statistical Modeling

Print Method for cat_tune Object

Description

This function prints a summary of the cat_tune object, displaying key details such as the function name, dimensions of covariates, tau sequence, optimal tau, likelihood or risk estimate, and the model's coefficients.

Usage

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

Arguments

x	An object of class cat_tune, typically resulting from a tuning process, including cat_glm_tune, cat_cox_tune and cat_lmm_tune.
digit	An integer indicating the number of decimal places for printing coefficient estimates. Default is 3.
detail	A logical value indicating whether to include additional detailed output at the end of the summary. If TRUE, it will print additional interpretation help.
...	Additional parameters to pass to other functions.

Details

This method provides a comprehensive overview of the tuning process for the model, including the tau sequence and optimal tau, along with either the maximum likelihood (for Cox models) or minimum risk estimate (for other models). It also displays the coefficients of the model.

The function also checks if the x is a Cox model (cat_cox_tune) to adjust the interpretation of the output.

Value

The x object is returned invisibly.

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