printClassifier: Print Information about a Classifier Object

In predomics/predomicspkg: Interpretable Prediction in Omics Data

Print Information about a Classifier Object

Description

This function prints detailed information about a classifier object, including information about the experiment, the learner settings, and the models within the classifier. It provides a structured view of the classifier's parameters and any relevant attributes to facilitate understanding and debugging.

Usage

printClassifier(obj, indent = "\t--- ")

Arguments

obj	A classifier object, typically returned by a classifier training function. The object should contain details about the experiment, model parameters, and possibly a collection of models.
indent	A string for indentation used when printing information. It allows for hierarchical display, making the output easier to read and understand. Default is " — ".

Details

- If the classifier object contains an experiment attribute, the function prints details of the experiment. - If the classifier has parameters ('params'), it prints the learner type, its parameters, and, if applicable, any models used in the classifier. - If the classifier includes a model collection, details of the models are printed as well.

Value

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

Author(s)

Edi Prifti (IRD)

Examples

## Not run: 
# Assuming 'classifier' is a valid classifier object
printClassifier(classifier)

## End(Not run)

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