calculate_funnel_points: For rate-based funnels: Derive rate and annual population...

In PHEindicatormethods: Common Public Health Statistics and their Confidence Intervals

For rate-based funnels: Derive rate and annual population values for charting based. Process removes rates where the rate type is dsr and the number of observed events are below 10.

Description

For rate-based funnels: Derive rate and annual population values for charting based. Process removes rates where the rate type is dsr and the number of observed events are below 10.

Usage

calculate_funnel_points(
  data,
  numerator,
  denominator,
  rate,
  rate_type = NULL,
  years_of_data = NULL,
  multiplier = NULL
)

Arguments

data	a data.frame containing the data to calculate control limits for; unquoted string; no default
numerator	field name from data containing the observed numbers of cases in the sample meeting the required condition (the numerator or observed counts for the control limits); unquoted string; no default
denominator	field name from data containing the population(s) in the sample (the denominator or expected counts for the control limits); unquoted string; no default
rate	field name from data containing the rate data when creating funnels for a Crude or Directly Standardised Rate; unquoted string; no default
rate_type	if statistic is "rate", specify either "dsr" or "crude"; string; no default
years_of_data	number of years the data represents; this is required for statistic = "rate"; numeric; no default
multiplier	the multiplier used to express the final values (eg 100 = percentage); numeric; no default

Value

returns the same table as provided with two additional fields. First will have the same name as the rate field, with the suffix "_chart", the second will be called denominator_derived

Author(s)

Sebastian Fox, [e-mail]

See Also

Other PHEindicatormethods package functions: assign_funnel_significance(), calculate_ISRate(), calculate_ISRatio(), calculate_funnel_limits(), phe_dsr(), phe_life_expectancy(), phe_mean(), phe_proportion(), phe_quantile(), phe_rate(), phe_sii()

PHEindicatormethods documentation built on May 31, 2023, 8:13 p.m.