mtkIshigamiEvaluator-class: The 'mtkIshigamiEvaluator' class

In mtk: Mexico ToolKit library (MTK)

Description

The mtkIshigamiEvaluator class is a sub-class of the class mtkEvaluator used to manage the simulation of the model Ishigami.

Class Hierarchy

Parent classes :

mtkEvaluator

Direct Known Subclasses :

Constructor

mtkIshigamiEvaluator

signature()

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. Here, it takes the character "R".

site:

(character) a string to indicate where the service is located. Here, it always takes the string "mtk".

service:

(character) a string to name the service to invoke. Here, it always takes the string "Ishigami".

parameters:

(vector) a vector of [mtkParameter] containing the parameters to pass while calling the service. The "Ishigami" model does not need parameters.

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 = "mtkIshigamiEvaluator", name = "character"): non useful, method inherited from the parent class.

setParameters

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

getParameters

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

is.ready

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

setReady

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

is.ready

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

setReady

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

getResult

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

getData

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

serializeOn

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

run

signature(this = "mtkIshigamiEvaluator", context= "mtkExpWorkflow"): runs the simulation.

summary

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

print

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

plot

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

report

signature(this = "mtkIshigamiEvaluator"): 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

# Carry out a sensitivity analysis with the Ishigami model

##	Input the factors
	data(Ishigami.factors)

##	Specify the experiments designer
	designer <- mtkNativeDesigner ("BasicMonteCarlo", 
		information=list(size=20))

##	Specify the model simulator
	model <- mtkIshigamiEvaluator()
	
##	Specify the sensiticity analyser
	analyser <- mtkNativeAnalyser("Regression", information=list(nboot=20) )

##	Specify the workflow
	ishiReg <- new("mtkExpWorkflow", expFactors=Ishigami.factors,
		   processesVector=c(
				              design=designer,
				              evaluate=model,
				              analyze=analyser)
			  				)
## Run and report the results
	run(ishiReg)
	summary(ishiReg)

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