rescaleFunction-methods: Methods for Function rescaleFunction in Package 'RobExtremes'

rescaleFunction-methodsR Documentation

Methods for Function rescaleFunction in Package ‘RobExtremes’

Description

rescaleFunction provides the default rescaling for a particular L2-Family for wrapper functions PlotIC, ComparePlotIC, InfoPlot, and CniperPointPlot.

Usage

rescaleFunction(L2Fam, ...)
## S4 method for signature 'GEVFamily'
rescaleFunction(L2Fam, dataFlag,rescaleFlag)
## S4 method for signature 'GParetoFamily'
rescaleFunction(L2Fam, dataFlag,rescaleFlag)
## S4 method for signature 'GEVFamilyMuUnknown'
rescaleFunction(L2Fam, dataFlag,rescaleFlag)

Arguments

L2Fam

an object of class "L2ParamFamily" to be dispatched on.

dataFlag

logical; determines whether data is plotted in or not.

rescaleFlag

logical; shall we rescale at all?

...

further arguments for the particular methods not be dispatched on.

Details

rescaleFunction is realized as an S4 method in order to be able to provide default rescalings for (new) particular L2 Families ex post to be used in the wrapper functions

Value

a list with arguments needed for the rescaling by internal function .rescalefct; more specifically it always contains items scaleX and scaleY, and if dataFlag==TRUE, also items scaleX.fct, scaleX.inv, scaleY.fct, scaleY.inv, x.ticks, y.ticks.

Author(s)

Peter Ruckdeschel peter.ruckdeschel@uni-oldenburg.de,
Mykhailo Pupashenko myhailo.pupashenko@gmail.com


RobExtremes documentation built on Feb. 12, 2024, 3:01 a.m.