plotStratZV: Plot local z-score variance to assess calibration and...

View source: R/plotStratZV.R

plotStratZVR Documentation

Plot local z-score variance to assess calibration and tightness for stratified conditioning variables

Description

Plot local z-score variance to assess calibration and tightness for stratified conditioning variables

Usage

plotStratZV(
  X,
  Z,
  varZ = 1,
  aggregate = TRUE,
  popMin = 100,
  greedy = TRUE,
  plot = TRUE,
  method = c("cho", "bootstrap", "chisq", "auto"),
  BSmethod = c("bca", "perc", "basic"),
  nBoot = 5000,
  parallel = FALSE,
  xlab = "Conditioning variable",
  ylim = NULL,
  title = "",
  label = 0,
  gPars = ErrViewLib::setgPars()
)

Arguments

X

(vector) abscissae of the Z values

Z

(vector) set of z-score values to be tested

varZ

(numeric) target value for Var(Z) (default '1')

aggregate

(logical) aggregate contiguous strata smaller than popMin (default: TRUE)

popMin

(integer) minimal count in a stratum

greedy

(logical) use greedy algorithm to merge strata (default: TRUE)

plot

(logical) plot the results

method

(string) method used to estimate 95 percent CI on Var(Z)

BSmethod

(string) bootstrap variant

nBoot

(integer) number of bootstrap replicas

parallel

(logical) parallelized bootstrap (default: 'FALSE')

xlab

(string) X axis label

ylim

(vector) limits of the y axis

title

(string) a title to display above the plot

label

(integer) index of letter for subplot tag

gPars

(list) graphical parameters

Value

Invisibly returns a list of LZV results. Mainly 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
  X   = signif(uE,1)
  plotStratZV(X, E/uE, method = 'cho', ylim = c(0,2))


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