aitoa.plot.stat.over.param: Plot a Statistic over the Values of a Given Parameter

Description Usage Arguments

View source: R/plot_stat_over_param.R

Description

Plot an end statistic over the values of a given parameter.

Usage

 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
aitoa.plot.stat.over.param(
  end.result.stats,
  algorithm.template,
  algorithm.primary.args,
  algorithm.primary.filler = .default.primary.template.filler,
  algorithm.secondary.args = NULL,
  algorithm.secondary.args.name = NULL,
  algorithm.secondary.filler = .default.secondary.template.filler,
  instances,
  statistic,
  instance.colors = aitoa.distinct.colors(length(instances)),
  instance.lwd = .default.lwd,
  instance.pch = NULL,
  secondary.arg.lty = if (is.null(algorithm.secondary.args)) .default.lty else c(1L,
    aitoa.distinct.lty(length(algorithm.secondary.args) - 1L)),
  legend.pos = "topright",
  legend.cex = .legend.cex,
  legend.bg = .legend.bg,
  mgp = .default.mgp,
  tck = .default.tck,
  cex = .default.cex,
  mar = .default.mar.without.labels,
  divide.by = NULL,
  mark.min.fun = .default.mark.min,
  x.axis.at = NULL,
  full.data.required = TRUE,
  ...
)

Arguments

end.result.stats

the end result statistics frame

algorithm.template

the algorithm template: a string where $arg will be replaced with the parameter value and which will then be matched with the algorithm column in the data frame

algorithm.primary.args

the values of the primary argument

algorithm.primary.filler

a function taking in an algorithm name template and an argument value and returning an algorithm name. The default replaces the string $arg1 with the value.

algorithm.secondary.args

values of an optional secondary argument

algorithm.secondary.args.name

the optional name of the optional secondary argument

algorithm.secondary.filler

a function taking in an algorithm name template (resulting from algorithm.primary.filler) and the two algorithm argument values and returns an algorithm name. The default replaces the string $arg2 with the value of the secondary argument.

instances

a potentially named list of instances; if names are given, the names are diplayed in the legend, otherwise the instance strings

statistic

the statistic to plot

instance.colors

the colors to use for the instances

instance.lwd

the line widths to be used for the instances

instance.pch

the symbol to be used for the instances

secondary.arg.lty

the line types to be used for the secondary argument

legend.pos

the legend position

legend.cex

the legend character size

legend.bg

the legend background

mgp

the mgp value

tck

the tck value

cex

the base character scaling

mar

the margin value

divide.by

optionally, a per-instance value to divide the statistic by

mark.min.fun

the function for marking the minima. If not NULL, this must be a function with six arguments, namely

min.x

the vector with the x-coordinates minal values

min.y

the vector with the y-coordinates minal values

color

the color for these points

pch

the pch value for these points, or NULL if none

lty

the line type for these points

lwd

the line width for these points

This function, if not NULL, is called once for each instance

x.axis.at

the location of the x-axis ticks: optional

full.data.required

if TRUE, an exception will be thrown if there is not one data point for every single x-value; if FALSE, missing data points are allowed. The default is TRUE.

...

parameters to be passed to plot


thomasWeise/aitoaEvaluate documentation built on Dec. 6, 2020, 1:22 p.m.