surv_table: Format prevalence results for knitr tables

In survinger: Design-Adjusted Inference for Pathogen Lineage Surveillance

Format prevalence results for knitr tables

Description

Produces a publication-ready summary table from any survinger result. Automatically called when objects are printed inside RMarkdown chunks if knitr is loaded.

Usage

surv_table(x, digits = 3, percent = TRUE, ...)

Arguments

x	A survinger result object.
digits	Integer. Decimal places for prevalence. Default 3.
percent	Logical. Display as percentages? Default TRUE.
...	Additional arguments (unused).

Value

A tibble formatted for display.

See Also

surv_lineage_prevalence(), tidy.surv_prevalence()

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)
prev <- surv_lineage_prevalence(d, "BA.2.86")
surv_table(prev)

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