mtkFastAnalyser-class: The 'mtkFastAnalyser' class

In mtk: Mexico ToolKit library (MTK)

Description

The mtkFastAnalyser class is a sub-class of the class mtkAnalyser. It implements the sensitivity analysis method 'Fast' and provides all the slots and methods defined in the class mtkAnalyser.

Class Hierarchy

Parent classes :

mtkAnalyser

Direct Known Subclasses :

Constructor

mtkFastAnalyser

signature(mtkParameters = NULL, listParameters = NULL)

Slots

name:

(character): always takes the string "analyze".

protocol:

(character): always takes the string "R".

site:

(character): always takes the string "mtk".

service:

(character): always takes the string "Fast".

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 = "mtkFastAnalyser", name = "character"): Not used, method inherited from the parent class.

setParameters

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

getParameters

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

is.ready

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

setReady

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

is.ready

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

setReady

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

getResult

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

getData

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

serializeOn

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

run

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

summary

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

print

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

plot

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

report

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

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.

See Also

help(fast, sensitivity)

Examples

##			 Sensitivity analysis of the "Ishigami" model with the "Fast" method 

#	Input the factors
		data(Ishigami.factors)
		
# 	Build the processes and workflow:

#   1) the design process
		exp1.designer <- mtkFastDesigner(listParameters
	    	= list(n=1000)) 

#   2) the simulation process
		exp1.evaluator <- mtkNativeEvaluator(model="Ishigami") 

#   3) the analysis process 
		exp1.analyser <- mtkFastAnalyser()

#   4) the workflow

		exp1 <- mtkExpWorkflow(expFactors=Ishigami.factors,
	    processesVector = c(design=exp1.designer,
		evaluate=exp1.evaluator, analyze=exp1.analyser))

# 	Run the workflow and reports the results.
		run(exp1)
		print(exp1)

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