FunnelPlotR (version 0.2.3)

build_limits_lookup: Function to build funnel limits

Description

Internal function for funnel plot to build the control limits prior to plotting.

Usage

build_limits_lookup(
  min_preds,
  max_preds,
  min_ratio,
  max_ratio,
  Poisson_limits,
  OD_adjust,
  Tau2,
  method,
  multiplier
)

Arguments

min_preds

Minimum predicted value for range of x-axis

max_preds

Maximum predicted value for range of x-axis

min_ratio

Minimum ratio value for range of y-axis

max_ratio

Maximum ratio value for range of y-axis

Poisson_limits

TRUE/FALSE Draw Poisson distribution limits?

OD_adjust

TRUE/FALSE Use overdispersion adjustment

Tau2

If using OD_adjust, what is the Tau2 ("between" standard error) to use?

method

Which adjustment method is being used, SHMI or CQC?

multiplier

Multiply ratio value by an amount. Default is 1, but some mortality ratios use 100, for example.

Value

A data.frame with an index column and various control limits based on the index as an x-axis value.