InfoPlotWrapper: Wrapper function for information plot method

InfoPlotR Documentation

Wrapper function for information plot method

Description

The wrapper InfoPlot (captial I!) takes most of arguments to the plot method infoPlot (lower case i!) by default and gives a user possibility to run the function with low number of arguments.

Usage

  InfoPlot(IC, data, ..., alpha.trsp = 100,
    with.legend = TRUE, rescale = FALSE, withCall = TRUE)

Arguments

IC

object of class IC

data

optional data argument — for plotting observations into the plot

...

additional parameters (in particular to be passed on to plot)

alpha.trsp

the transparency argument (0 to 100) for ploting the data

with.legend

the flag for showing the legend of the plot

rescale

the flag for rescaling the axes for better view of the plot

withCall

the flag for the call output

Value

invisible(retV) where retV is the return value of the respective call to the full-fledged function infoPlot with the additional item wrapcall with the call to the wrapper InfoPlot and wrappedcall the call to to the full-fledged function infoPlot.

Details

Calls infoPlot with suitably chosen defaults. If withCall == TRUE, the call to infoPlot, i.e., item wrappedcall of the (hidden) return value, is returned

Examples

# Gamma
fam  <-  GammaFamily()
IC <- optIC(model = fam, risk = asCov())
Y <- distribution(fam)
data  <-  r(Y)(500)
InfoPlot(IC, data, withCall = FALSE)

RobAStBase documentation built on Feb. 2, 2024, 3 p.m.