FunnelPlotR (version 0.2.3)

OD_adjust_func: Winsorisation and adjusted z-score function

Description

Internal function to perform the winsorisation and adjustment of z-scores prior to plotting.

Usage

OD_adjust_func(
  mod_plot_agg = mod_plot_agg,
  method = "SHMI",
  Winsorise_by = 0.1,
  multiplier = 1,
  bypass = FALSE
)

Arguments

mod_plot_agg

Aggregated model input data

method

Adjustment method, can take the value \"SHMI\" or \"CQC\". \"SHMI\" is default.

Winsorise_by

The amount to winsorise\/truncate the distribution by, prior to transformation. 0.1 means 10% (at each end).

multiplier

The amount to multiply the standardised ratio by, default is 1.

bypass

TRUE\/FALSE, whether to bypass adjustment (not yet in use in main function)

Value

A list with elements\: aggregated adjusted data fame, Phi (a numeric dispersion ratio), Tau2 (a numeric \"between\" standard error)'