expand_truth: Creates a range of bins to score

Description Usage Arguments Value

View source: R/expand_truth.R

Description

Expands the observed truth across a range of bins

Usage

1
2
3
expand_truth(truth, week_expand = 1, percent_expand = 5, week53 = F,
  challenge = "ilinet", expand_by_percent = F,
  percent_observed = 0.1)

Arguments

truth

A data.frame including columns unit and bin_start_incl

week_expand

A scalar numeric (default 1) indicating the number of bins to include around the observed value for week targets.

percent_expand

A scalar numeric (default 5) indicating the number of bins to include around the observed value for percent or rate targets. If expand_by_percent = TRUE then this value is ignored.

week53

A logical value (default 'FALSE') indicating whether to include MMWR week 53 in the expanded truth.

challenge

one of "ilinet", "hospital" or "state_ili", indicating which challenge the submission is for (default "ilinet").

expand_by_percent

A logical value (default 'FALSE') indicating whether to expand truth around percent or ratetargets by a percentage of the observed value.

percent_observed

A scalar numeric between 0 and 1 (default 0.1), indicating the one-sided percentage of the observed percent or rate target that will be included. If expand_by_percent = FALSE then this value is ignored.

Value

A data.frame with expanded truth


jarad/FluSight documentation built on Oct. 24, 2020, 9:58 p.m.