Coverage of true parameter values within credible intervals.
Constructor for CoverageMetric.
Usage
CoverageMetric(
name = "coverage",
needs = character(0),
required = FALSE,
summary_type = "proportion",
schema = list(mean = list(role = "estimate", aggregation = "mean", mcse = "sd"),
by_param = list(role = "binary", aggregation = "proportion", mcse = "binomial")),
prob = 0.95
)
coverage_metric(name = "coverage", prob = 0.95)Arguments
- name
Character string naming the metric. Defaults to "coverage".
- needs
Character vector of required capabilities. Defaults to empty character vector.
- required
Logical indicating if metric failure causes task failure. Defaults to FALSE.
- prob
Numeric probability for the credible interval width. Defaults to 0.95.