plotEvsPU: Plot error E vs predicted value V or prediction uncertainty...

View source: R/plotEvsPU.R

plotEvsPUR Documentation

Plot error E vs predicted value V or prediction uncertainty uE

Description

Plot error E vs predicted value V or prediction uncertainty uE

Usage

plotEvsPU(
  X,
  Y,
  type = c("prop", "horiz"),
  runExt = FALSE,
  runQuant = FALSE,
  runMode = FALSE,
  runMean = FALSE,
  runVar = FALSE,
  runMS = FALSE,
  cumMAE = FALSE,
  probs = c(0.95),
  xlab = NULL,
  ylab = NULL,
  logX = FALSE,
  logY = FALSE,
  title = NULL,
  myColors = c(5, 4, 3, 1, 2),
  xlim = NULL,
  ylim = NULL,
  scalePoints = 0.5,
  nBin = NULL,
  slide = TRUE,
  label = 0,
  showLegend = TRUE,
  legLoc = "topleft",
  gPars = ErrViewLib::setgPars()
)

Arguments

X

(vector) prediction uncertainty, uE, or predicted value, V

Y

(vector) error or z-score

type

(string) type of guide lines ('prop' or 'horiz')

runExt

(logical) plot extremal points

runQuant

(logical) plot running quantiles (cf. probs)

runMode

(logical) plot running mode of distribution

runMean

(logical) plot running mean

runVar

(logical) plot running variance

runMS

(logical) plot running mean squares (exclusive with 'runVar')

cumMAE

(logical) plot cumulative MAE

probs

(vector) probability levels for quantile-based confidence intervals

xlab

(string) x axis label

ylab

(string) y axis label

logX

(logical) log-transform X

logY

(logical) log-transform Y after taking absolute value

title

(string) a title to display above the plot

xlim

(vector) limits of the X axis

ylim

(vector) limits of the y axis

scalePoints

(numeric) scale factor for points size

nBin

(integer) number of intervals for local coverage stats

slide

(logical) use sliding window for subsetting (X,Y)

label

(integer) index of letter for subplot tag

showLegend

(logical) display legend

legLoc

(string) location of legend (see xy.coord)

gPars

(list) graphical parameters

Value

Plots E vs uE or V

Examples


  uE  = sqrt(rchisq(1000, df = 4))  # Re-scale uncertainty
  E   = rnorm(uE, mean=0, sd=uE)  # Generate errors
  plotEvsPU(uE, E, runQuant = TRUE)


ppernot/ErrViewLib documentation built on June 1, 2024, 4:33 a.m.