mtkEvaluator: The constructor of the class 'mtkEvaluator'

In mtk: Mexico ToolKit library (MTK)

Description

The constructor

Usage

mtkEvaluator(protocol = "R", site = "mtk", service = "",
 	parameters = NULL, parametersList = NULL, ready = TRUE,
 	 state = FALSE, result = NULL)

Arguments

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	a string corresponding to the name of the method implemented in the package "mtk" or the service that implements the process if remotely.
parameters	a vector of [mtkParameter] representing the parameters necessary to run the process.
parametersList	a named list containing the parameters to pass while calling the process. This gives another way to specify the parameters.
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 the class [mtkEvaluatorResult] to hold the results produced by the Evaluator.

Value

an object of the mtkEvaluator class

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 an evaluator with the model "Ishigami" implemented in the package "mtk".
 
 	evaluator1 <- mtkEvaluator(service="Ishigami")
 
# Create an evaluator avec the model "WWDM"  implemented in the package "mtk"
 	evaluator2 <- mtkEvaluator(service="WWDM", 
 			parametersList=list(year=3, tout=FALSE))

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