mtkProcess: The constructor of the 'mtkProcess' class

Description Usage Arguments Value Details Author(s) References Examples

View source: R/mtkProcess.R

Description

The constructor

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
mtkProcess(
	name,
	protocol = "R", 
	site = "mtk", 
	service = "", 
	parameters = NULL, 
	ready = FALSE, 
	state = FALSE, 
	result = NULL
	)

Arguments

name

the processing step associated with this process. It may be "design", "evaluate", or "analyze".

protocol

a string from "http", "system", "R" respectively representing if the process is implemented remotety, locally or as R function.

site

the site where the process is implemented if remotely or the package where the process is implemented if as a R function.

service

the service name or a system call that implements the process.

parameters

a vector of [mtkParameter] representing the parameters necessary to run the process.

ready

a logical to indicate if the process is ready to run.

state

a logical to indicate if the process finished running and the results are available.

result

an object of a class derived from [mtkResult] to hold the results produced by the process.

Value

an object of the mtkProcess class

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, [email protected]

References

J. Wang, H. Richard, R. Faivre, H. Monod (2013). Le package mtk, une biblioth<c3><a8>que R pour l'exploration num<c3><a9>rique des mod<c3><a8>les. In: Analyse de sensibilit<c3><a9> et exploration de mod<c3><a8>les : Application aux sciences de la nature et de l'environnement (R. Faivre, B. Iooss, S. Mah<c3><a9>vas, D. Makowski, H. Monod, Eds). Editions Quae, Versailles.

Examples

1
# see examples with help(mtkNativeDesigner)

mtk documentation built on May 29, 2017, 5:34 p.m.