mtkAnalyser: The constructor of the class 'mtkAnalyser'

Description Usage Arguments Value Author(s) References Examples

View source: R/mtkAnalyser.R

Description

The constructor

Usage

1
2
3
 mtkAnalyser(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 remotely, 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 necessary to run the process. It 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 [mtkAnalyserResult] to hold the results produced by the analyser.

Value

an object of the mtkAnalyser class

Author(s)

Juhui WANG, MIA-Jouy, Inra, [email protected]a.fr

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
2
3
4
# Creates an analyser avec the method "Morris" implemented 
# in the package "mtk"
	analyser <- mtkAnalyser(service="Morris", 
		parametersList=list(nboot=20))

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