printPopulation: Print Information about a Population of Models

In predomics/predomicspkg: Interpretable Prediction in Omics Data

Print Information about a Population of Models

Description

This function prints detailed information about a population of models. It supports multiple methods for displaying the model summaries, such as providing a "digested" view, a "short" version, or a more detailed "long" view. It can also print the structure of each model within the population.

Usage

printPopulation(obj, method = "short", score = "fit_", indent = "")

Arguments

obj	A population of models. This should be a valid object returned by a model training procedure.
method	A string specifying the format in which the population summary will be printed. Possible values are "digested", "short", "long", and "str". "digested" provides a summarized view of the population's properties, "short" gives a brief summary of each model, "long" provides a more detailed view, and "str" prints the structure of each model in the population.
score	A string specifying the score attribute to be used when printing models. Default is "fit_".
indent	A string used for indentation when printing information, helpful when displaying hierarchical data.

Details

- The "digested" method provides an overview of the population, summarizing key attributes such as the sparsity and learner type. - The "short" method gives a brief summary of each model, including its learner, language, and evaluation score. - The "long" method offers a detailed description of each model, including all relevant information about coefficients and evaluation metrics. - The "str" method prints the structure of each model using 'str()'.

Value

None. The function prints the information directly.

Author(s)

Edi Prifti (IRD)

Examples

## Not run: 
# Assuming 'population' is a valid population of models
printPopulation(population, method = "short")

## End(Not run)

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