Skip to contents

The network response profile behind the campaign response window. Samples that follow a campaign in their own district are grouped by country and by band of weeks since the start of that campaign (profile_breaks in es_score_settings()). For each band, the denominator is the number of samples and the numerator the number with Sabin virus detected.

Usage

calc_es_score_profile(
  samples,
  campaigns,
  benchmark_iso = NULL,
  from = as.Date("2016-01-01"),
  as_of = Sys.Date(),
  settings = es_score_settings(),
  cols = list()
)

Arguments

samples

Cleaned environmental sample table, one row per sample, such as polished_es. Duplicate sample identifiers are kept once.

campaigns

Cleaned campaign table, such as polished_sia.

benchmark_iso

ISO3 codes of the countries that make up the network. NULL (default) uses every country in samples.

from

First collection date read. Default 1 January 2016.

as_of

The reporting date, as a Date or a string that as.Date() reads. Defaults to Sys.Date(). It is the last collection date read.

settings

Windows, distances, thresholds and labels, built with es_score_settings().

cols

Named list of column overrides keyed by table (samples, campaigns, isolation), in the style of calc_polio_indicators(). See es_score_cols() for the keys and defaults.

Value

A tibble with columns iso, bin (a factor), samples and sabin_pct (on a scale of 0 to 100, rounded to one decimal place), sorted by country and band.