prop_diff {junco} | R Documentation |
Proportion difference estimation
Description
The analysis function a_proportion_diff_j()
can be used to create a layout element to estimate
the difference in proportion of responders within a studied population. The primary analysis variable,
vars
, is a logical variable indicating whether a response has occurred for each record. See the method
parameter for options of methods to use when constructing the confidence interval of the proportion difference.
A stratification variable can be supplied via the strata
element of the variables
argument.
Usage
a_proportion_diff_j(
df,
.var,
ref_path,
.spl_context,
...,
.stats = NULL,
.formats = NULL,
.labels = NULL,
.indent_mods = NULL
)
s_proportion_diff_j(
df,
.var,
.ref_group,
.in_ref_col,
variables = list(strata = NULL),
conf_level = 0.95,
method = c("waldcc", "wald", "cmh", "ha", "newcombe", "newcombecc", "strat_newcombe",
"strat_newcombecc"),
weights_method = "cmh"
)
Arguments
df |
( |
.var |
( |
ref_path |
( |
.spl_context |
( |
... |
Additional arguments passed to the statistics function. |
.stats |
( |
.formats |
( |
.labels |
( |
.indent_mods |
( |
.ref_group |
( |
.in_ref_col |
( |
variables |
( |
conf_level |
( |
method |
( |
weights_method |
( |
Value
-
a_proportion_diff_j()
returns the corresponding list with formattedrtables::CellValue()
.
-
s_proportion_diff_j()
returns a named list of elementsdiff
,diff_ci
,diff_est_ci
anddiff_ci_3d
.
Functions
-
a_proportion_diff_j()
: Formatted analysis function which is used asafun
inestimate_proportion_diff()
. -
s_proportion_diff_j()
: Statistics function estimating the difference in terms of responder proportion.
Note
The a_proportion_diff_j()
function has the _j
suffix to distinguish it
from tern::a_proportion_diff()
. The functions here are a copy from the tern
package
with additional features:
Additional statistic
diff_est_ci
is returned.-
ref_path
needs to be provided as extra argument to specify the control group column.
When performing an unstratified analysis, methods 'cmh'
, 'strat_newcombe'
,
and 'strat_newcombecc'
are not permitted.
Examples
nex <- 100
dta <- data.frame(
"rsp" = sample(c(TRUE, FALSE), nex, TRUE),
"grp" = sample(c("A", "B"), nex, TRUE),
"f1" = sample(c("a1", "a2"), nex, TRUE),
"f2" = sample(c("x", "y", "z"), nex, TRUE),
stringsAsFactors = TRUE
)
l <- basic_table() |>
split_cols_by(var = "grp") |>
analyze(
vars = "rsp",
afun = a_proportion_diff_j,
show_labels = "hidden",
na_str = tern::default_na_str(),
extra_args = list(
conf_level = 0.9,
method = "ha",
ref_path = c("grp", "B")
)
)
build_table(l, df = dta)
s_proportion_diff_j(
df = subset(dta, grp == "A"),
.var = "rsp",
.ref_group = subset(dta, grp == "B"),
.in_ref_col = FALSE,
conf_level = 0.90,
method = "ha"
)
s_proportion_diff_j(
df = subset(dta, grp == "A"),
.var = "rsp",
.ref_group = subset(dta, grp == "B"),
.in_ref_col = FALSE,
variables = list(strata = c("f1", "f2")),
conf_level = 0.90,
method = "cmh"
)