mtkProcess-class: The 'mtkProcess' class

In mtk: Mexico ToolKit library (MTK)

Description

The mtkProcess is a class to represent the processes managed within the workflow. It provides a generic mechanism for conceptualizing the common behavior of the processes used in experimental design, model simulation and sensitivity analysis.

Class Hierarchy

Parent classes :

Direct Known Subclasses :

mtkDesigner,mtkEvaluator, mtkAnalyser

Constructor

mtkProcess

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

Slots

name:

(character) a string to name the step of the analysis: "design", "evaluate" or "analyze".

protocol:

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

site:

(character) a string to indicate where the service is located: "mtk", URI, etc.

service:

(character) a string to name the service to invoke.

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 keep the results produced by the process

Methods

setName

signature(this = "mtkProcess", name = "character"): Gives a name to the process.

getName

signature(this = "mtkProcess"): Returns the name of the process.

setParameters

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

getParameters

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

is.ready

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

setReady

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

is.ready

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

setReady

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

getResult

signature(this = "mtkProcess"): Returns the results produced by the process as a mtkResult.

getData

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

serializeOn

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

run

signature(this = "mtkProcess", context= "mtkExpWorkflow"): Runs the process.

summary

signature(object = "mtkProcess", ...): Displays a summary of the results produced by the process.

print

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

plot

signature(x = "mtkProcess", y, ... ): Plots the results produced by the process.

report

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

Details

The mtkProcess class is a virtual class to manage the generic properties of processes involved in the "mtk" package.

For details uses, see examples from help(mtkNativeDesigner), help(mtkNativeEvaluator), help(mtkNativeAnalyser), .

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

# see examples with help(mtkNativeDesigner)

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