R/translink_samplesize.R
translink_samplesize.Rd
This function calculates the sample size needed to identify transmission links at a predefined false discovery rate, given a final outbreak size \(N\).
translink_samplesize(
sensitivity,
specificity,
N,
R = NULL,
tdr,
min_pairs = 1,
assumption = "mtml"
)
scalar or vector giving the sensitivity of the linkage criteria
scalar or vector giving the specificity of the linkage criteria
scalar or vector giving the final outbreak size
scalar or vector giving the effective reproductive number of the pathogen
scalar or vector giving the desired true discovery rate (1-false discovery rate)
minimum number of linked pairs observed in the sample, defaults to 1 pair (2 samples); this is to ensure reasonable results are obtained
a character vector indicating which assumptions about transmission and linkage criteria. Default = 'mtml'
. Accepted arguments are:
'stsl'
for the single-transmission single-linkage assumption.
'mtsl'
for the multiple-transmission single-linkage assumption.
'mtml'
for the multiple-transmission multiple-linkage assumption.
scalar or vector giving the sample size needed to meet the given conditions
Other transmission linkage functions:
translink_expected_links_obs_mtml()
,
translink_expected_links_obs_mtsl()
,
translink_expected_links_obs_stsl()
,
translink_expected_links_obs()
,
translink_expected_links_true_mtml()
,
translink_expected_links_true_mtsl()
,
translink_expected_links_true_stsl()
,
translink_expected_links_true()
,
translink_fdr()
,
translink_prob_transmit_mtml()
,
translink_prob_transmit_mtsl()
,
translink_prob_transmit_stsl()
,
translink_prob_transmit()
,
translink_tdr()
translink_samplesize(sensitivity=0.99, specificity=0.995, N=100, R=1, tdr=0.75)
#> [1] 10