mtkEvaluator-class: The 'mtkEvaluator' class

In mtk: Mexico ToolKit library (MTK)

Description

The mtkEvaluator class is a sub-class of the class mtkProcess used to manage the model simulation. It provides all the slots and methods defined in the class mtkProcess.

Class Hierarchy

Parent classes :

mtkProcess

Direct Known Subclasses :

mtkNativeEvaluator,mtkWWDMEvaluator, etc.

Constructor

mtkEvaluator

signature(protocol = "R", site = "mtk", service = "", parameters = NULL, parametersList = NULL, ready = TRUE, state = FALSE, result = NULL)

Slots

name:

(character) always takes the string "evaluate".

protocol:

(character) a string to name the protocol used to run the process: http, system, R, etc.

site:

(character) a string to indicate where the service is located.

service:

(character) a string to name the service to invoke.

parameters:

(vector) a vector of [mtkParameter] containing the parameters to pass while calling the service.

ready:

(logical) a logical to tell if the process is ready to run.

state:

(logical) a logical to tell if the results produced by the process are available and ready to be consumed.

result:

(ANY) a data holder to hold the results produced by the process

Methods

setName

signature(this = "mtkEvaluator", name = "character"): Not used, method inherited from the parent class.

setParameters

signature(this = "mtkEvaluator", f = "vector"): Assigns new parameters to the process.

getParameters

signature(this = "mtkEvaluator"): Returns the parameters as a named list.

is.ready

signature( = "mtkEvaluator"): Tests if the process is ready to run.

setReady

signature(this = "mtkEvaluator", switch = "logical"): Makes the process ready to run.

is.ready

signature( = "mtkEvaluator"): Tests if the results produced by the process are available.

setReady

signature(this = "mtkEvaluator", switch = "logical"): Marks the process as already executed.

getResult

signature(this = "mtkEvaluator"): Returns the results produced by the process as a [mtkEvaluatorResult].

getData

signature(this = "mtkEvaluator"): Returns the results produced by the process as a data.frame.

serializeOn

signature(this = "mtkEvaluator"): Returns all data managed by the process as a named list.

run

signature(this = "mtkEvaluator", context= "mtkExpWorkflow"): Runs the model with the experimental design defined in the context.

summary

signature(object = "mtkEvaluator"): Provides a summary of the results produced by the process.

print

signature(x = "mtkEvaluator"): Prints a report of the results produced by the process.

plot

signature(x = "mtkEvaluator"): Plots the results produced by the process.

report

signature(this = "mtkEvaluator"): Reports the results produced by the process.

Author(s)

Juhui WANG, MIA-Jouy, Inra, [e-mail]

References

J. Wang, H. Richard, R. Faivre, H. Monod (2013). Le package mtk, une bibliothèque R pour l'exploration numérique des modèles. In: Analyse de sensibilité et exploration de modèles : Application aux sciences de la nature et de l'environnement (R. Faivre, B. Iooss, S. Mahévas, D. Makowski, H. Monod, Eds). Editions Quae, Versailles.

Examples

# Create an evaluator with the model "Ishigami" 
# implemented in the package "mtk".
 	 evaluator1 <- mtkEvaluator(service="Ishigami")
 
# Create an evaluator with the model "WWDM"
# implemented in the package "mtk"
	 evaluator2 <- mtkEvaluator(service="WWDM", 
 			parametersList=list(year=3, tout=FALSE))

mtk documentation built on May 2, 2019, 4:15 a.m.