plotRelDiag: Plot reliability diagram

View source: R/plotRelDiag.R

plotRelDiagR Documentation

Plot reliability diagram

Description

Plot reliability diagram

Usage

plotRelDiag(
  X,
  Y,
  ordX = NULL,
  aux = NULL,
  logX = FALSE,
  nBin = NULL,
  equiPop = TRUE,
  popMin = 30,
  logBin = TRUE,
  intrv = NULL,
  skewupUnc = 0.6,
  skewupErr = 0.8,
  method = c("bootstrap", "cho"),
  BSmethod = c("bca", "perc", "basic"),
  nBoot = 500,
  slide = FALSE,
  plot = TRUE,
  score = TRUE,
  xlim = NULL,
  ylim = NULL,
  title = "",
  unit = "",
  label = 0,
  add = FALSE,
  col = 5,
  colInv = 2,
  gPars = ErrViewLib::setgPars()
)

Arguments

X

(vector) vector of uncertainties

Y

(vector) vector of errors

ordX

(vector) set of abscissas to order sample

aux

(vector) auxilliary vector to resolve ties in sample sorting

logX

(logical) log-transform X

nBin

(integer) number of intervals for local coverage stats

equiPop

(logical) generate intervals with equal bin counts (default: 'equiPop = TRUE')

popMin

(integer) minimal bin count in an interval

logBin

(logical) if 'equiPop = FALSE', one can choose between equal range intervals, or equal log-range intervals (default 'logBin = TRUE')

intrv

(object) intervals generated by 'genIntervals' (default: 'NULL')

skewupUnc

(numeric) upper limit for robust skewness of uE^2, used for reliability estimation (defaul: 0.6). The unreliable bins are grayed out. Set to NULL to inactivate this check.

skewupErr

(numeric) upper limit for robust skewness of E^2, used for reliability estimation (defaul: 0.8). The unreliable bins are grayed out. Set to NULL to inactivate this check.

method

(string) one of 'bootstrap' (default) and 'cho'

BSmethod

(string) bootstrap variant

nBoot

(integer) number of bootstrap replicas

slide

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

plot

(function) produce plot ?

score

(logical) estimate calibration metrics ?

xlim

(vector) min and max values of X axis

ylim

(vector) limits of the y axis

title

(string) a title to display above the plot

unit

(string) unit string to add to xlab and ylab

label

(integer) index of letter for subplot tag

add

(logical) add to previous graph ?

col

(integer) color index of bin stats

colInv

(integer) color index of invalid bin stats

gPars

(list) graphical parameters

Value

Used for its plotting side effect.

Examples


  uE  = sqrt(rchisq(1000, df = 4))  # Re-scale uncertainty
  E   = rnorm(uE, mean=0, sd=uE)  # Generate errors
  plotRelDiag(uE, E, nBin = 6, nBoot = 500)


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