boxplot.Siid: Boxplot for Siid

boxplot.SiidR Documentation

Boxplot for Siid

Description

Boxplots with simultaenous error bars around all quantiles for iid data.

Usage

## S3 method for class 'Siid'
boxplot(x, ...,  alpha = 0.05, thresh = 0.001, 
                     quan.col = 'lightsteelblue3', opaq = .6, range = 1.5, 
                     width = NULL, varwidth = FALSE, outline = TRUE, plot = TRUE, 
                     border = par("fg"), col = 'white', ann = !add, 
                     horizontal = FALSE, add = FALSE)

Arguments

x

: a ‘Siid’ class object

...

: arguments sent to boxplot

alpha

: confidence level of simultaneous confidence intervals

thresh

: numeric typically less than .005 for the accuracy of the simulteaneous procedure

quan.col

: color for the quantile confidence intervals

opaq

: opacity of mean.col and quan.col. A value of 0 is transparent and 1 is completely opaque.

range

: as defined for base boxplot

width

: as defined for base boxplot

varwidth

: as defined for base boxplot

outline

: as defined for base boxplot

plot

: logical indicating whether the plot is to be constructed

border

: as defined for base boxplot

col

: as defined for base boxplot

ann

: as defined for base boxplot

horizontal

: as defined for base boxplot

add

: as defined for base boxplot

Value

returns the base boxplot with simultaneous confidence intervals around all quantiles

References

Robertson, N., Flegal, J. M., Vats, D., and Jones, G. L., “Assessing and Visualizing Simultaneous Simulation Error”, Journal of Computational and Graphical Statistics, 2020.

Examples

# Generating iid data
chain <- matrix(rnorm(3*1e3), nrow = 1e3, ncol = 3)
siid.obj <- Siid(chain)
boxplot(siid.obj)


dvats/SimTools documentation built on May 14, 2023, 1:28 p.m.