ciu.ggplot {ciu}

ciu.ggplot

Description

Function for plotting out the effect of changing values of one input on one output.

Usage

ciu.ggplot(
  ciu,
  instance,
  ind.input = 1,
  ind.output = 1,
  in.min.max.limits = NULL,
  n.points = 40,
  main = NULL,
  xlab = NULL,
  ylab = NULL,
  ylim = NULL,
  illustrate.CIU = FALSE,
  neutral.CU = 0.5,
  CIU.illustration.colours = c("red", "orange", "green", "blue")
)

Arguments

ciu

ciu object as created with ciu function (not to be confused with CIU object as created by ciu.new).

instance

Input values for the instance to explain. Should be a data.frame even though a vector or matrix might work too if input names and other needed metadata can be deduced from the dataset or other parameters given to ciu.new.

ind.input

Index of input feature to plot.

ind.output

Index of output to plot.

in.min.max.limits

data.frame or matrix with one row per output and two columns, where the first column indicates the minimal value and the second column the maximal value for that output. ONLY NEEDED HERE IF not given as parameter to ciu.new or if the limits are different for this specific instance than the default ones.

n.points

How many x,y pairs will be calculated, equally spaced over in.min.max.limits.

main

Text to use as main title.

xlab

Label for x-axis.

ylab

Label for y-axis.

ylim

Minimal and maximal values for y-axis.

illustrate.CIU

Include illustration of CIU Cmin, Cmax, neutral.CU. Default is FALSE

neutral.CU

Value of neutral.CU. Default is 0.5.

CIU.illustration.colours

Colours to use for illustrating CIU. Default is red, orange, green.

Value

ggplot object.

Author(s)

Kary Främling