Last data update: 2014.03.03

R: Plot section views of a function
sectionview.funR Documentation

Plot section views of a function

Description

Plot one section view per dimension of a function thus providing a better understanding of the model behaviour.

Usage

  sectionview.fun(fun,
    dim = ifelse(is.null(center), 1, length(center)),
    center = NULL, axis = NULL, npoints = 100,
    col_surf = "blue", mfrow = NULL, Xname = NULL,
    yname = NULL, Xscale = 1, yscale = 1, xlim = c(0, 1),
    ylim = NULL, title = NULL, add = FALSE, ...)

Arguments

fun

an object of class "function".

dim

the dimension of fun arguments.

center

optional coordinates (as a list or data frame) of the center of the section view if the model's dimension is > 1.

axis

optional matrix of 1-axis combinations to plot, one by row. The value NULL leads to all possible combinations i.e. 1:D.

npoints

an optional number of points to discretize plot of response surface and uncertainties.

col_surf

color for the section.

mfrow

an optional list to force par(mfrow = ...) call. The default value NULL is automatically set for compact view.

xlim

a list to give x range for all plots.

ylim

an optional list to force y range for all plots.

Xname

an optional list of string to overload names for X.

yname

an optional string to overload name for y.

Xscale

an optional factor to scale X.

yscale

an optional factor to scale y.

title

an optional overload of main title.

add

to print graphics on an existing window.

...

further arguments passed to the first call of plot.

Details

A multiple rows/columns plot is produced.

Author(s)

Yann Richet, IRSN

See Also

The function sectionview3d.fun produces a 3D version.

Examples

## A 2D example - Branin-Hoo function.
sectionview.fun(branin,center=c(.5,.5))

Results


R version 3.3.1 (2016-06-21) -- "Bug in Your Hair"
Copyright (C) 2016 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)

R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
Type 'license()' or 'licence()' for distribution details.

R is a collaborative project with many contributors.
Type 'contributors()' for more information and
'citation()' on how to cite R or R packages in publications.

Type 'demo()' for some demos, 'help()' for on-line help, or
'help.start()' for an HTML browser interface to help.
Type 'q()' to quit R.

> library(DiceView)
Loading required package: DiceKriging
Loading required package: DiceEval
Loading required package: rgl
> png(filename="/home/ddbj/snapshot/RGM3/R_CC/result/DiceView/sectionview.fun.Rd_%03d_medium.png", width=480, height=480)
> ### Name: sectionview.fun
> ### Title: Plot section views of a function
> ### Aliases: sectionview.fun
> ### Keywords: models
> 
> ### ** Examples
> 
> ## A 2D example - Branin-Hoo function.
> sectionview.fun(branin,center=c(.5,.5))
> 
> 
> 
> 
> 
> dev.off()
null device 
          1 
>