surv_detection_probability: Variant detection probability under current design

View source: R/06-detection.R

surv_detection_probabilityR Documentation

Variant detection probability under current design

Description

Variant detection probability under current design

Usage

surv_detection_probability(
  design,
  true_prevalence,
  delay_fit = NULL,
  n_periods = 1L,
  detection_threshold = 1L
)

Arguments

design

A surv_design object.

true_prevalence

Numeric in (0,1).

delay_fit

Optional surv_delay_fit.

n_periods

Integer. Accumulation periods. Default 1.

detection_threshold

Integer. Min detections. Default 1.

Value

A list with overall, cumulative, by_stratum, parameters.

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_detection_probability(d, 0.01)


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