example_model: Example model

In computational-metabolomics/struct: Statistics in R Using Class-based Templates

Example model

Description

An example model for testing. Training this model adds value_1 to a data set, and prediction using this model adds value_2.

trains the example model, which adds value_1 to the raw data of a dataset

predicts using the example model, which adds value_2 to the raw data of a dataset

Usage

example_model(value_0 = 0, value_1 = 10, value_2 = 20, ...)

## S4 method for signature 'example_model,DatasetExperiment'
model_train(M, D)

## S4 method for signature 'example_model,DatasetExperiment'
model_predict(M, D)

Arguments

value_0	a numeric value
value_1	a numeric value
value_2	a numeric value
...	named slots and their values.
M	A struct model object
D	A DatasetExperiment object

Value

modified example_model object

dataset object

dataset object

Examples

M = example_model()
M = example_model(value_1 = 10, value_2 = 20)
D = iris_DatasetExperiment()
M = example_model(value_1 = 10, value_2 = 20)
M = model_train(M,D)
D = iris_DatasetExperiment()
M = example_model(value_1 = 10, value_2 = 20)
M = model_predict(M,D)

computational-metabolomics/struct documentation built on March 27, 2024, 4:26 p.m.