incidence_rate | R Documentation |
Estimate the event rate adjusted for person-years at risk, otherwise known as incidence rate. Primary analysis variable is the person-years at risk.
estimate_incidence_rate(
lyt,
vars,
n_events,
control = control_incidence_rate(),
na_str = default_na_str(),
nested = TRUE,
...,
show_labels = "hidden",
table_names = vars,
.stats = NULL,
.formats = NULL,
.labels = NULL,
.indent_mods = NULL
)
s_incidence_rate(
df,
.var,
n_events,
is_event,
control = control_incidence_rate()
)
a_incidence_rate(
df,
.var,
n_events,
is_event,
control = control_incidence_rate()
)
lyt |
( |
vars |
( |
n_events |
( |
control |
(
|
na_str |
( |
nested |
( |
... |
additional arguments for the lower level functions. |
show_labels |
( |
table_names |
( |
.stats |
( |
.formats |
(named |
.labels |
(named |
.indent_mods |
(named |
df |
( |
.var |
( |
is_event |
( |
estimate_incidence_rate()
returns a layout object suitable for passing to further layouting functions,
or to rtables::build_table()
. Adding this function to an rtable
layout will add formatted rows containing
the statistics from s_incidence_rate()
to the table layout.
s_incidence_rate()
returns the following statistics:
person_years
: Total person-years at risk.
n_events
: Total number of events observed.
rate
: Estimated incidence rate.
rate_ci
: Confidence interval for the incidence rate.
a_incidence_rate()
returns the corresponding list with formatted rtables::CellValue()
.
estimate_incidence_rate()
: Layout-creating function which can take statistics function arguments
and additional format arguments. This function is a wrapper for rtables::analyze()
.
s_incidence_rate()
: Statistics function which estimates the incidence rate and the
associated confidence interval.
a_incidence_rate()
: Formatted analysis function which is used as afun
in estimate_incidence_rate()
.
control_incidence_rate()
and helper functions h_incidence_rate.
library(dplyr)
df <- data.frame(
USUBJID = as.character(seq(6)),
CNSR = c(0, 1, 1, 0, 0, 0),
AVAL = c(10.1, 20.4, 15.3, 20.8, 18.7, 23.4),
ARM = factor(c("A", "A", "A", "B", "B", "B"))
) %>%
mutate(is_event = CNSR == 0) %>%
mutate(n_events = as.integer(is_event))
basic_table() %>%
split_cols_by("ARM") %>%
add_colcounts() %>%
estimate_incidence_rate(
vars = "AVAL",
n_events = "n_events",
control = control_incidence_rate(
input_time_unit = "month",
num_pt_year = 100
)
) %>%
build_table(df)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.