Last data update: 2014.03.03
R: The 'mtkAnalyser' class
mtkAnalyser-class R Documentation
The mtkAnalyser
class
Description
The mtkAnalyser
class is a sub-class of the class mtkProcess
used to manage
the sensitivity analysis process. It provides all the slots and methods defined in the class mtkProcess
.
Class Hierarchy
Parent classes : mtkProcess
Direct Known Subclasses : mtkNativeAnalyser
,mtkMorrisAnalyser
, etc.
Constructor
mtkAnalyser
signature(protocol="R", site="mtk", service="", parameters=NULL,
parametersList=NULL, ready=TRUE, state=FALSE, result=NULL)
Slots
name
:(character
) a string to name the processing type. Here, it always takes "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.
service
:(character
) a string to name the method or the service (if remotely) 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
) NULL or an object of the class mtkAnalyserResult
to hold the results produced by the process
Methods
setName
signature(this = "mtkAnalyser", name = "character"): Not used, just inherited from the parent class.
setParameters
signature(this = "mtkAnalyser", f = "vector"): Assigns a new vector of parameters to the process.
getParameters
signature(this = "mtkAnalyser"): Returns the parameters as a named list.
is.ready
signature( = "mtkAnalyser"): Tests if the process is ready to run.
setReady
signature(this = "mtkAnalyser", switch = "logical"): Makes the process ready to run.
is.ready
signature( = "mtkAnalyser"): Tests if the results produced by the process are available.
setReady
signature(this = "mtkAnalyser", switch = "logical"): Marks the process as already executed.
getResult
signature(this = "mtkAnalyser"): Returns the results produced by the process as a mtkAnalyserResult
.
getData
signature(this = "mtkAnalyser"): Returns the results produced by the process as a data.frame.
serializeOn
signature(this = "mtkAnalyser"): Returns all data managed by the process as a named list.
run
signature(this = "mtkAnalyser", context= "mtkExpWorkflow"): Runs the sensitivity analysis on the model defined in the context.
summary
signature(object = "mtkAnalyser"): Provides a summary of the results produced by the process.
print
signature(x = "mtkAnalyser"): Prints a report of the results produced by the process.
plot
signature(x = "mtkAnalyser"): Builds a plot of the results produced by the process.
report
signature(this = "mtkAnalyser"): Reports the results produced by the process.
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<c3><83><c2><a8>que R pour l'exploration num<c3><83><c2><a9>rique des mod<c3><83><c2><a8>les.
In: Analyse de sensibilit<c3><83><c2><a9> et exploration de mod<c3><83><c2><a8>les : Application aux sciences de la nature et de l'environnement
(R. Faivre, B. Iooss, S. Mah<c3><83><c2><a9>vas, D. Makowski, H. Monod, Eds). Editions Quae, Versailles.
Examples
# Creates an analyser avec the method "Morris"
# implemented in the package "mtk".
analyser <- mtkAnalyser(service="Morris",
parametersList=list(nboot=20))
Results