build_limits_lookup: Function to build funnel limits

Description Usage Arguments Value

View source: R/build_limits_lookup.R

Description

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

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
build_limits_lookup(
  min_x,
  max_x,
  min_y,
  max_y,
  draw_adjusted,
  tau2,
  data_type,
  sr_method,
  target,
  multiplier,
  denominators
)

Arguments

draw_adjusted

TRUE/FALSE Use overdispersion adjustment

tau2

If using draw_adjusted, what is the tau2 ("between" standard error) to use?

data_type

SR, PR or RC. Used to set target reference

sr_method

Which adjustment method is being used, SHMI or CQC?

target

target to be used to set centre line

multiplier

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

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

draw_unadjusted

TRUE/FALSE Draw Poisson distribution limits?

Value

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


FunnelPlotR documentation built on Sept. 30, 2021, 5:07 p.m.