compare_standardised_rates: Direct Standardised Prevalence Rates

Description Usage Arguments Value

View source: R/compare_standardised_rates.R

Description

Direct Standardised Prevalence Rates

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
compare_standardised_rates(
  df,
  Geography,
  LocalityA,
  LocalityB,
  Condition,
  Population_Standard = NULL,
  Verbose = TRUE,
  ...
)

Arguments

df

a tidy dataframe in standard Master Patient Index format ie SangerTools::PopHealthData

Geography

Column name denoting column with location string names

LocalityA

A character string from @param Geography

LocalityB

A character string from @param Geography

Condition

A Health condition flag denoted by 1 & 0

Population_Standard

Population Standard Weight for Standardising; defaults to NULL which will use Age Structure of @param df

Verbose

Takes boolean value to determine function output printing

...

Variables to Standardise by; Must always have Ageband, additional variables are optional

Value

List of length 2 containing 2 tibbles with standardised rates for @param LocalityA and @param LocalityB


ald0405/SangerTools documentation built on Jan. 14, 2022, 9:42 p.m.