autoplot_calibrateType1: Graphical Display of the Bias or Type 1 Error

autoplot_calibrateType1R Documentation

Graphical Display of the Bias or Type 1 Error

Description

Graphical display of the bias or type 1 error for the output of calibrateType1.

Usage

## S3 method for class 'calibrateType1'
autoplot(
  object,
  type = "bias",
  plot = TRUE,
  color.threshold = "red",
  type.bias = "absolute",
  alpha = 0.05,
  nrow.legend = NULL,
  name2label = NULL,
  color = NULL,
  keep.method = NULL,
  ...
)

Arguments

object

output of calibrateType1.

type

[character] if type equals "bias" the bias will be displayed. Otherwise if it equals "type1error" the type 1 error will be displayed.

plot

[logical] should the plot be displayed?

color.threshold

[character] the color for the line representing the expected value(s).

type.bias

[character] if type.bias equals "absolute" the absolute bias will be used. Otherwise if it equals "relative" the relative bias will be used. Only relevant when type equals "bias".

alpha

[numeric, 0-1] the significance threshold to consider. Only relevant when type equals "type1error".

nrow.legend

[integer, >0] the number of rows for the legend. Only relevant when type equals "type1error".

name2label

[named character vector] the label for the legend. The vector should contain the method names (see details). Only relevant when type equals "type1error".

color

[character vector] a vector of colours to be used to color the lines. Only relevant when type equals "type1error".

keep.method

[character vector] the methods names for which the type 1 error should be displayed. Only relevant when type equals "type1error".

...

[internal] Only used by the generic method.

Details

Method names:

  • p.Ztest

  • p.Satt

  • p.KR

  • p.robustZtest

  • p.robustSatt

  • p.robustKR

Value

An list containing:

  • plot: a ggplot object.

  • data: the dataset used to generate the ggplot object.


lavaSearch2 documentation built on April 12, 2023, 12:33 p.m.