summary,mtkProcess-method: The 'summary' method

In mtk: Mexico ToolKit library (MTK)

Description

Returns a summary report of the results produced by the process.

Usage

summary(object, ...)

Arguments

object	the underlying object of class mtkProcess.
...	see the help for the function: base::summary().

Value

The form of the value returned by summary depends on the sub-class where the method is implemented.

By default, it prints the report on the display device.

Details

1. The behavior of the print depends on the sub-class where the method is implemented.

2. See the documentation of the particular sub-class for details of what is produced.

3. Use methods("summary") to get all the methods for the summary generic.

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

# Carry out a sensitivity analysis with the Ishigami model

##	Input the factors
	data(Ishigami.factors)

##	Specify the experiments designer
	designer <- mtkNativeDesigner ("BasicMonteCarlo", 
		information=list(size=20))

##	Specify the model simulator
	model <- mtkIshigamiEvaluator()
	
##	Specify the sensiticity analyser
	analyser <- mtkNativeAnalyser("Regression", information=list(nboot=20) )

##	Specify the workflow
	ishiReg <- new("mtkExpWorkflow", expFactors=Ishigami.factors,
		   processesVector=c(
				              design=designer,
				              evaluate=model,
				              analyze=analyser)
			  				)
## Run and report a summary of the results produced by the workflow
	run(ishiReg)
	summary(ishiReg)

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