Skip to contents

Calculate Avertable Burden Estimates

Source: R/fn_make.R
make_avertable_summary.Rd

Combines synthetic population burden estimates, service coverage profiles and intervention effectiveness estimates to calculate avertable burden metrics.

Usage

make_avertable_summary(
  agents_dt,
  impact_dt,
  services_dt,
  avertable_col = "AvertableFraction",
  burden_col = "DALYBurden",
  count_col = "Persons",
  mean_col = "PerPersonDALYs",
  rank_col = "DALYsAvertedPerRecipient",
  service_fraction_col = "Popn_Percent_share",
  summary_cols = c("TotalAvertableDALYs", "DALYsAvertedPerRecipient",
    "DALYsAvertedPerCase"),
  total_col = "PopulationGroupDALYs"
)

Arguments

agents_dt

Synthetic agent population.

impact_dt

Table containing intervention impact estimates.

services_dt

Table describing service coverage profiles.

avertable_col

Name of the attributable-effect column. Defaults to "AvertableFraction".

burden_col

Name of the burden variable. Defaults to "DALYBurden".

count_col

Name of the population count column. Defaults to "Persons".

mean_col

Name of the mean burden column. Defaults to "PerPersonDALYs".

rank_col

Name of the metric used for ranking results. Defaults to "DALYsAvertedPerRecipient".

service_fraction_col

Name of the service coverage variable. Defaults to "Popn_Percent_share".

summary_cols

Names of the calculated summary metrics. Defaults to:

TotalAvertableDALYs

Total burden potentially avertable.

DALYsAvertedPerRecipient

Avertable burden per recipient.

DALYsAvertedPerCase

Avertable burden adjusted for service coverage.

total_col

Name of the total burden column. Defaults to "PopulationGroupDALYs".

Value

A ranked data.table containing service-planning estimates and avertable burden metrics.

Details

The function:

  1. Summarises burden across synthetic agents.

  2. Joins service profile data.

  3. Joins intervention effectiveness estimates.

  4. Calculates total and per-person avertable burden metrics.

  5. Ranks results according to a user-specified outcome measure.

This function forms the final calculation step in the illustrative avertable burden workflow.

Three summary measures are calculated by default:

TotalAvertableDALYs

Estimated total burden potentially avertable across a service target population.

DALYsAvertedPerRecipient

Estimated burden potentially avertable for an individual recipient of care.

DALYsAvertedPerCase

Estimated burden potentially avertable after accounting for service coverage levels.

Results are ordered from highest to lowest values according to rank_col.

See also

make_burden_lookup, make_summary_of_agents

Other burden modelling: make_burden_lookup(), make_summary_of_agents()

Examples

if (FALSE) { # \dontrun{
result_dt <- make_avertable_summary(
  agents_dt = agents_dt,
  impact_dt = avertable_dt,
  services_dt = care_profiles_dt,
  rank_col = "DALYsAvertedPerRecipient"
)
} # }