mtkNativeAnalyser-class: The 'mtkNativeAnalyser' class

In mtk: Mexico ToolKit library (MTK)

Description

The mtkNativeAnalyser class is a sub-class of the class mtkAnalyser used to manage the sensitivity analysis task implemented locally (i.e. tasks don't need to call services from the Web). It provides all the slots and methods defined in the class mtkAnalyser.

Class Hierarchy

Parent classes :

mtkAnalyser

Direct Known Subclasses :

Constructor

mtkNativeAnalyser

signature(analyze=NULL, X=NULL, information=NULL)

Slots

analyze:

(ANY) a string, an R function, or NULL to inform the method to use for the sensitivity analysis.

name:

(character) always takes the string "analyze".

protocol:

(character) a string to name the protocol used to run the process: http, system, R, etc. Here, it always takes "R".

site:

(character) a string to indicate where the service is located.

service:

(character) a string to name the service to invoke. Here, it may be a R function or a method implemented in the package "mtk".

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

setParameters

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

getParameters

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

is.ready

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

setReady

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

is.ready

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

setReady

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

getResult

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

getData

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

serializeOn

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

run

signature(this = "mtkNativeAnalyser", context= "mtkExpWorkflow"): Runs the Analyser.

summary

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

print

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

plot

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

report

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

Details

We can construct an object of the mtkNativeAnalyser class from the following situations:

1. The analyser is provided within the package "mtk";

2. The analyser is provided as an R function implemented outside the package "mtk"; If so, the R function must produce a result as a named list with two elements: X and information, where X is a date.frame containing the analysis result and information is a named list containing supplementary information about the analysis process.

3. The results of the model exploration are produced off-line and available as a data.frame. We just want to use the "mtk" package for reporting.

For detail uses, see examples from help(mtkNativeEvaluator).

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 native analyser with the method "Morris" implemented in the package "mtk"

	analyser <- mtkNativeAnalyser(
		analyze="Morris",
		information=list(nboot=20))

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