mtkDesigner-class: The 'mtkDesigner' class

In mtk: Mexico ToolKit library (MTK)

Description

The mtkDesigner class is a sub-class of the class mtkProcess used to manage the experiments design task. It provides all the slots and methods defined in the class mtkProcess.

Class Hierarchy

Parent classes :

mtkProcess

Direct Known Subclasses :

mtkNativeDesigner,mtkMorrisDesigner, etc.

Constructor

mtkDesigner

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

Slots

name:

(character) always takes the string "design".

protocol:

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

site

the site where the process is implemented if remotely or the package where the process is implemented if as a R function.

service

a string corresponding to the name of the method implemented in the package "mtk" or the service that implements the process if remotely.

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 from the class mtkDesignerResult to hold the results produced by the process.

Methods

setName

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

setParameters

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

getParameters

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

is.ready

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

setReady

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

is.ready

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

setReady

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

getResult

signature(this = "mtkDesigner"): Returns the results produced by the process as mtkDesignerResult.

getData

signature(this = "mtkDesigner"): Returns the results as a data.frame.

serializeOn

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

run

signature(this = "mtkDesigner", context= "mtkExpWorkflow"): Generates the experimental design by sampling the factors.

summary

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

print

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

plot

signature(x = "mtkDesigner"): Reports graphically the results produced by the process.

report

signature(this = "mtkDesigner"): 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 a designer with the method "Morris" 
# implemented in the package "mtk"
	designer <- mtkDesigner(service="Morris",
		 parametersList=list(nboot=20))

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