printExperiment: Print Information about an Experiment Object

In predomics/predomicspkg: Interpretable Prediction in Omics Data

Print Information about an Experiment Object

Description

This function prints detailed information about an experiment object, including details about the experiment, cross-validation, and the classifier used. It helps in understanding and inspecting the components of an experiment.

Usage

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

Arguments

obj	An experiment object that contains information about the classifier, cross-validation, and the models used in the experiment.
indent	A string for indentation, used to structure the printed output in a hierarchical manner. Default is " — ".

Details

- Prints details about the experiment, including information about the classifier and the experiment settings. - If cross-validation data exists, prints the number of folds, times, and seeds used in the cross-validation. - Prints detailed learner options such as learner type, parameters, and the models involved in the experiment.

Value

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

Author(s)

Edi Prifti (IRD)

Examples

## Not run: 
# Assuming 'experiment' is a valid experiment object
printExperiment(experiment)

## End(Not run)

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