-
-
Notifications
You must be signed in to change notification settings - Fork 49
/
plotExampleRun.Rd
95 lines (82 loc) · 3.92 KB
/
plotExampleRun.Rd
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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/plotExampleRun.R
\name{plotExampleRun}
\alias{plotExampleRun}
\title{Renders plots for exampleRun objects and displays them.}
\usage{
plotExampleRun(object, iters, pause = interactive(), densregion = TRUE,
se.factor = 1, single.prop.point.plots = FALSE, xlim = NULL,
ylim = NULL, point.size = 3, line.size = 1, trafo = NULL,
colors = c("red", "blue", "green"), gg.objects = list(), ...)
}
\arguments{
\item{object}{[\code{function}]\cr
\code{MBOExampleRun} object from \code{exampleRun} or
\code{MBOExampleRunMultiObj} object from \code{exampleRunMultiObj}.}
\item{iters}{[\code{integer}]\cr
Selected iterations of \code{object} to produce plots.
Default is all iterations.}
\item{pause}{[\code{logical(1)}]\cr
Should the process be paused after each iteration?
Default is \code{interactive()}.}
\item{densregion}{[\code{logical(1)}]\cr
Should the background be shaded? Default is \code{TRUE}.
Only used if learner supports computation of standard error.}
\item{se.factor}{[\code{numeric(1)}]\cr
If the model provides local standard error estimation,
in addition to the mean response \code{yhat(x) +- se.factor * se(x)}
is plotted above and below.
Default is 1.}
\item{single.prop.point.plots}{[\code{logical(1)}]\cr
Parameter for MOI-MBO Multi-point proposal: Should every proposed point
be displayed in a single plot - or one plot per Iteration? Default is FALSE
indicating single plots per proposed points.}
\item{xlim}{[\code{numeric(2)}]\cr
For 1D: \code{xlim} parameter for first and second plot.
Default is range of x-values evaluated in run object \code{x}.}
\item{ylim}{[\code{numeric(2)}]\cr
For 1D: \code{ylim} parameter for first plot, for the second plot \code{ylim} is always set
automatically, depending on the range of the evaluated infill criterion.
Default for the first plot is a heuristic to have the true function
and \code{yhat(x) +- se.factor2 * se(x)} both in the plot. Note that this heuristic might
change the \code{ylim} setting between plot iterations.}
\item{point.size}{[\code{numeric(1)}]\cr
Point size for plotted points. Default is 3.}
\item{line.size}{[\code{numeric(1)}]\cr
Line width of the graphs of plotted functions.}
\item{trafo}{[\code{list}]\cr
List of transformation functions of type \code{MBOTrafoFunction} for
the different plots.
For 1D: The list elements should be named with \dQuote{y} (applied to objective function and model)
or \dQuote{crit} (applied to the criterion). Only applied to plots with numeric parameters.
For 2D: The list should contain at least one element \dQuote{y}, \dQuote{yhat}, \dQuote{crit}
or \dQuote{se}.
This way one can specify different transformations for different plots.
If a single function is provided, this function is used for all plots.}
\item{colors}{[\code{character(3)}]
Specify colors for point in the plots. Must be a vector of length 3,
each element a color for the type design, prop and seq respectively.
Default is red for the initial design, blue for already proposed points
and green for the actual iteration.}
\item{gg.objects}{[\code{list)}]
List of \code{gg} objects that should be added to all ggplots.}
\item{...}{[any]\cr
Currently not used.}
}
\value{
Nothing.
}
\description{
The graphical output depends on the target function at hand.
- For 1D numeric functions the upper plot shows the true function (if known),
the model and the (infill) points. The lower plot shows the infill criterion.
- For 2D mixed target functions only one plot is displayed.
- For 2D numeric only target functions up to four plots are presented to the
viewer:
- levelplot of the true function landscape (with [infill] points),
- levelplot of the model landscape (with [infill] points),
- levelplot of the infill criterion
- levelplot of the standard error (only if learner supports standard error estimation).
- For bi-criteria target functions the upper plot shows the target space and the lower
plot displays the x-space.
}