surv_quality: Compute surveillance quality metrics

In survinger: Design-Adjusted Inference for Pathogen Lineage Surveillance

Compute surveillance quality metrics

Description

Returns a single-row tibble of design quality indicators suitable for inclusion in manuscripts. Analogous to broom::glance() but for the surveillance design itself.

Usage

surv_quality(design, target_lineage = NULL, target_prevalence = 0.01)

Arguments

design	A surv_design object.
target_lineage	Character or NULL. Default NULL auto-selects.
target_prevalence	Numeric. For detection calculation. Default 0.01.

Value

A single-row tibble with columns: n_obs, n_strata, gini, rate_ratio, effective_n, deff, detection_prob, mean_bias.

See Also

surv_report(), surv_design()

Examples

sim <- surv_simulate(n_regions = 3, n_weeks = 10, seed = 1)
d <- surv_design(sim$sequences, ~ region,
                 sim$population[c("region", "seq_rate")], sim$population)
surv_quality(d)

survinger documentation built on April 27, 2026, 9:10 a.m.