mtk (version 1.0)

mtkBasicMonteCarloDesigner-class: The mtkBasicMonteCarloDesigner class

Description

The mtkBasicMonteCarloDesigner class is a sub-class of the class mtkDesigner. It implements the BasicMonteCarlo method for experiments design and provides all the slots and methods defined in the class mtkDesigner.

Class Hierarchy

Parent classes :

mtkDesigner

Direct Known Subclasses :

Constructor

mtkBasicMonteCarloDesigner

signature(mtkParameters = NULL, listParameters = NULL)

Slots

name:

(character) always takes the string "design".

protocol:

(character) always takes the string "R".

site:

(character) always takes the string "mtk".

service:

(character) always takes the string "BasicMonteCarlo".

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 = "mtkBasicMonteCarloDesigner", name = "character"): Method inherited from the parent class.

setParameters

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

getParameters

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

is.ready

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

setReady

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

is.ready

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

setReady

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

getResult

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

getData

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

serializeOn

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

run

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

summary

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

print

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

plot

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

report

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

Details

See the BasicMonteCarlo method with help(BasicMonteCarlo)

References

1. A. Saltelli, K. Chan and E. M. Scott (2000). Sensitivity Analysis. Wiley, New York.
2. 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

# See examples from  the BasicMontecarlo method:  help(basicMonteCarlo)