Description Usage Arguments Details Value Author(s) References Examples
A function used to extend the "mtk" package with new analysis methods programmed as R functions.
The mtk.analyserAddons
function takes a R file as input and converts it into a mtk
compliant class which
can be seamlessly integrated into the mtk
package.
1 2 3 4 5 6 7 |
where |
NULL or a file holding the R function to convert. |
library |
NULL or the name of the library if the R function to convert is held in a library. |
authors |
NULL or information about the authors of the R function. |
name |
a string to name the method when used with the "mtk" package. |
main |
the R function which implements the method. |
summary |
NULL or a subversion of the |
plot |
NULL or a reprogrammed version of the |
print |
NULL or a reprogrammed version of the |
The new method must be programmed according to the following syntax:
main <- function(X, Y, ...)
where X
is a data.frame holding the experiment design,
and Y
is a data.frame holding the results produced by the model simulation.
The function main
returns a named list with two elements: main
and information
. The element
main
holds the result of the sensitivity analysis and the element information
is optional,
may be used to give supplementary information about the analysis process and the produced results.
Furthermore, in order to report the analysis results more precisely, users can redefine the generic functions:
summary (object, ...)
,
plot(x,y, ...)
,
print(x, ...)
.
invisble()
Juhui WANG, MIA-Jouy, Inra, Juhui.Wang@jouy.inra.fr
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.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 | # an example implementation of the method "Regression"
# called here "RegressionTest" is held in the file
# "inst/extdata/regressionSI.R"
rFile <- "regressionSI.R"
rFile <- paste(path.package("mtk", quiet = TRUE),
"/extdata/",rFile,sep = "")
# to convert the method "RegressionTest" to S4 classes
# compliant with the "mtk" package. The generated "mtk" compliant class
# is called "mtkXXXAnalyser.R" where XXX corresponds to the name of the method.
mtk.analyserAddons(where=rFile, authors="H. Monod,INRA",
name="RegressionTest",
main="regressionSI", print="print.regressionSI",
plot="plot.regressionSI")
# To use the method "RegressionTest" with the package "mtk",
# just source the generated new files
source("mtkRegressionTestAnalyser.R")
## Use the method "RegressionTest" to do sensitivity analysis
# 1) Define the factors
x1 <- make.mtkFactor(name="x1", distribName="unif",
distribPara=list(min=-pi, max=pi))
x2 <- make.mtkFactor(name="x2", distribName="unif",
distribPara=list(min=-pi, max=pi))
x3 <- make.mtkFactor(name="x3", distribName="unif",
distribPara=list(min=-pi, max=pi))
ishi.factors <- mtkExpFactors(list(x1,x2,x3))
# 2) Create a workflow with the "Ishigami" model and analyze it with the new method
ishiReg <- mtkExperiment(expFactors=ishi.factors,
design="BasicMonteCarlo",designInfo=list(size=20),
model="Ishigami",
analyze="RegressionTest",
)
# 3) Run the workflow and report the results
run(ishiReg)
summary(ishiReg)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.