printModelCollection: Print Information about a Model Collection

In predomics/predomicspkg: Interpretable Prediction in Omics Data

Print Information about a Model Collection

Description

This function prints detailed information about a collection of models. It allows for summarizing the model collection in either a short or long format, providing insights into the models' sparsity, performance, and other relevant details.

Usage

printModelCollection(obj, indent = "\t--- ", method = "long")

Arguments

obj	A model collection object containing multiple models.
indent	A string for indentation, used to structure the printed output in a hierarchical manner. Default is " — ".
method	A string specifying the format for printing. Valid options are "short" and "long". Default is "long".

Details

- In "short" mode, it prints the names of the models in the collection along with the number of models in each category. - In "long" mode, it prints detailed information about each model, including the k-sparsity and a summary of the models' characteristics. - The "long" mode will call the 'printPopulation' function for each model in the collection to show its details.

Value

None. The function prints the information directly to the console.

Author(s)

Edi Prifti (IRD)

Examples

## Not run: 
# Assuming 'model_collection' is a valid model collection object
printModelCollection(model_collection, method = "short")

## End(Not run)

predomics/predomicspkg documentation built on Dec. 11, 2024, 11:06 a.m.