mtkDesigner: The constructor of the class 'mtkDesigner'

Description Usage Arguments Value Author(s) References Examples

Description

The constructor

Usage

1
2
3
mtkDesigner(protocol = "R", site = "mtk", service = "", 
 		parameters = NULL, parametersList = NULL, ready = TRUE, 
 		state = FALSE, result = NULL)

Arguments

protocol

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

site

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

service

(character) a string to name the method or the service (if remotely) to invoke.

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 a class derived from [mtkDesignerResult] to hold the results produced by the designer.

Value

an object of the mtkDesigner class

Author(s)

Juhui WANG, MIA-Jouy, Inra, Juhui.Wang@jouy.inra.fr

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

1
2
3
4
# Create a designer with the method "Morris" 
# implemented in the package "mtk"
	designer <- mtkDesigner(service="Morris", 
		parametersList=list(nboot=20))

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