Control function for incidence rate — control_incidence_rate • tern

This is an auxiliary function for controlling arguments for the incidence rate, used internally to specify details in s_incidence_rate().

Usage

control_incidence_rate(
  conf_level = 0.95,
  conf_type = c("normal", "normal_log", "exact", "byar"),
  time_unit_input = c("year", "day", "week", "month"),
  time_unit_output = 1
)

Arguments

conf_level: (proportion)
confidence level of the interval.
conf_type: (string)
normal (default), normal_log, exact, or byar for confidence interval type.
time_unit_input: (string)
day, month, or year (default) indicating time unit for data input.
time_unit_output: (numeric)
time unit for desired output (in person-years).

Value

A list of components with the same names as the arguments.

See also

Examples

control_incidence_rate(0.9, "exact", "month", 100)
#> $conf_level
#> [1] 0.9
#> 
#> $conf_type
#> [1] "exact"
#> 
#> $time_unit_input
#> [1] "month"
#> 
#> $time_unit_output
#> [1] 100
#>