plotCC: Plot confidence curve for (uE,E) set. Interface to...

View source: R/plotConfidence.R

plotCCR Documentation

Plot confidence curve for (uE,E) set. Interface to plotConfidence with different default arguments.

Description

Plot confidence curve for (uE,E) set. Interface to plotConfidence with different default arguments.

Usage

plotCC(
  E,
  uE,
  statS = c("RMSE", "RMSD", "MAE", "Q95"),
  normalize = FALSE,
  oracle = FALSE,
  probref = TRUE,
  conf_probref = TRUE,
  dist_probref = c("Normal", "Uniform", "Normp4", "Laplace", "T4"),
  rep_probref = 500,
  plot = TRUE,
  score = TRUE,
  confStat = score,
  col = 6,
  add = FALSE,
  xlab = "k% discarded",
  xlim = NULL,
  ylim = NULL,
  title = NULL,
  label = 0,
  showUk = FALSE,
  showLegend = TRUE,
  unit = "",
  legend = NULL,
  legLoc = "bottomleft",
  gPars = ErrViewLib::setgPars()
)

Arguments

E

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

uE

(vector) error or z-score

statS

(string) statistic to use. One of 'RMSE' (default), 'MAE' or 'Q95'

normalize

(logical) use normalized statistic (default: FALSE)

oracle

(logical) plot oracle curve (default: FALSE)

probref

(logical) plot probabilistic reference (probref) curve (default: TRUE)

conf_probref

(logical) plot confidence band around probref curve (default: TRUE)

dist_probref

(string) model error distribution to generate the reference curve. One of 'Normal' (default), 'Uniform', 'Normp4', 'Laplace' or 'T4'

rep_probref

(integer) sampling repetitions for normal curve (default = 500)

plot

(function) produce plot ?

score

(logical) estimate DFPR and/or AUCO

confStat

(logical) estimate DFPR and/or AUCO

col

(integer) color index for the curve (default: 6)

add

(logical) add confidence curve to previous plot (default: FALSE)

xlab

(string) x axis label (default: 'k % discarded)

xlim

(vector) limits of the x axis (default: NULL)

ylim

(vector) limits of the y axis (default: NULL)

title

(string) a title to display above the plot (default: ”)

label

(integer) index of letter for subplot tag (default: 0)

showUk

(logical) plot secondary axis with u_k values; supersedes 'title'

showLegend

(logical) display legend (default: TRUE)

unit

(string) unit string to add to ylab

legend

(string) legend for the dataset (default: NULL)

legLoc

(string) location of legend (see xy.coord) (default: 'bottomleft')

gPars

(list) graphical parameters (default: ErrViewLib::setgPars())

Value

Plot confidence curve for (E,uE) set

Examples


  uE  = sqrt(rchisq(1000, df = 4))  # Re-scale uncertainty
  E   = rnorm(uE, mean=0, sd=uE)  # Generate errors
  plotCC(E, uE, statS = 'MAE')


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