mtk (version 1.0)

mtkPLMMAnalyser-class: The mtkPLMMAnalyser class

Description

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

Class Hierarchy

Parent classes :

mtkAnalyser

Direct Known Subclasses :

Constructor

mtkPLMMAnalyser

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 "PLMM".

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

setParameters

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

getParameters

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

is.ready

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

setReady

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

is.ready

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

setReady

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

getResult

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

getData

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

serializeOn

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

run

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

summary

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

print

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

plot

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

report

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

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

# see examples with help(PLMM)