plot.bivRegion {refreg}R Documentation

Plot a bivRegion object

Description

This function allow to depict the estimated bivariate reference/probabilistic region, in the estandarized residuals scale (cond=FALSE), or for any covariate value (cond=TRUE).

Usage

## S3 method for class 'bivRegion'
plot(
  x,
  tau = 0.95,
  newdata = NULL,
  reg.col = NULL,
  reg.lwd = 1,
  reg.lty = NULL,
  axes = TRUE,
  axes.col = "black",
  axes.lwd = 2L,
  cond = FALSE,
  add = FALSE,
  legend = TRUE,
  ...
)

Arguments

x

A bivRegion object.

tau

A number, or vector, defining the desired coverage(s) of the bivariate reference region.

newdata

If cond=FALSE, a data.frame with new values to be depicted in the standarized residuals scale. If cond=TRUE, a data frame containing covariate values for which the reference/probabilistic region will be depicted.

reg.col

Region line colour, in case of more than one tau it can be a vector.

reg.lwd

Region line width, in case of more than one tau it can be a vector.

reg.lty

Region line type, in case of more than one tau it can be a vector.

axes

Logical; if TRUE (and cond=FALSE), vertical and horizontal lines are added indicating four quadrants in the model residuals scale.

axes.col

Axes colour.

axes.lwd

Axes line width.

cond

A logical argument, if TRUE a conditional reference region is depicted.

add

A logical argument, if TRUE the conditional reference region is depicted over a pre existing plot.

legend

A logical argument, if TRUE a legend is given along with the reference region.

...

Further plot parameters.

Value

This function return a graphical representation for a bivRegion object.

Examples

Y <- cbind(rnorm(100), rnorm(100))
Y <- as.data.frame(Y)
names(Y) <- c("y1", "y2")
reg <- bivRegion(Y, tau = 0.95, shape = 2)
plot(reg)

[Package refreg version 0.1.1 Index]