mf_create_text_values: function to create text objects for monthly factsheets

In PublicHealthEngland/hcaidcs: R functions for the mandatory surveillance of bacteraemia and C. difficile infection

function to create text objects for monthly factsheets

Description

The factsheet creates object which contain percentage change in the count of cases for use within the bullet points of the text. These bullet points compare the count of cases with the counts of cases at various different time points.

Usage

mf_create_text_values(data = trend, collection, output_reqd)

Arguments

data	A dataframe, in the context of the monthly factsheet, this will almost certainly be 'trend'
collection	A character string, one of "mrsa", "mssa", "ecoli", "kleb", "paer", "cdi"
output_reqd	A character string, one of "12_month", "3_month", "sum_12"

Value

A numeric value giving the percentage difference to different comparisons.

Examples

data("mf_trend_data")
mf_trend_data <- mf_lag_trend(mf_trend_data)

cdi_12_month <- mf_create_text_values(data = mf_trend_data, collection = "cdi",
  output_reqd = "12_month")
cdi_12_month

PublicHealthEngland/hcaidcs documentation built on Jan. 19, 2024, 8:38 a.m.