R/relR_samplesize_basic.R
relR_samplesize_basic.Rd
Function that does the simple derived sample size calculation with no corrections. I.e., directly applies the math as if sensitivity and specificity are perfect.
relR_samplesize_basic(
R_a,
R_b,
p_a,
N,
alpha = 0.05,
alternative = c("two_sided", "less", "greater"),
power = 0.8,
overdispersion = NULL,
allow_impossible_m = FALSE
)
Numeric (Positive). The assumed R among the group in the denominator of the ratio. Input value must be greater than 0.
Numeric (Positive). The assumed R among the group in the numerator of the ratio. Input value must be greater than 0.
Numeric. The proportion of the population in group a
. Must be
between 0 and 1.
Numeric (Positive). The size of the infected pool. Only one of
rho
or N
should be specified.
Numeric. The desired alpha level. Default: 0.05
Character. Specifies the alternative hypothesis.
Must be: two_sided
(Default), less
, or greater
Numeric. The desired power. Must be a value between 0 and 1. Default: 0.8.
Numeric (Positive). An overdispersion parameter, set
if the assumed distribution of the number of edges is negative binomial.
If NULL
the assumed distribution is Poisson (equivalent to an
overdispersion parameter of infinity) Default: NULL
Note that this is
equivalent to setting the overdispersion parameter to Inf
.
Logical. Indicates whether a value for m
can be
returned that is greater than the input N
. Default: FALSE
.
The required sample size. NA
if larger than N
.