sim_ss_norm: Empirically determine the operating characteristics of a...

View source: R/sim_ss_norm.R

sim_ss_normR Documentation

Empirically determine the operating characteristics of a single-stage multi-arm clinical trial for a normally distributed primary outcome

Description

sim_ss_norm() determines the operating characteristics of a specified single-stage multi-arm clinical trial design assuming the primary outcome is normally distributed, for given values of the true treatment effects, using simulation.

Usage

sim_ss_norm(
  des = des_ss_norm(integer = TRUE),
  tau,
  replicates = 1e+05,
  summary = FALSE
)

Arguments

des

A list of class "multiarm_des_ss_norm", as returned by build_ss_norm or des_ss_norm (i.e., a single-stage multi-arm clinical trial design for a normally distributed outcome). Note: The sample sizes in all arms must be whole numbers. Defaults to des_ss_norm(integer = TRUE).

tau

A matrix whose rows indicate values of τ at which to evaluate the operating characteristics. Defaults internally to the global null, global alternative, and each of the least favourable configurations if unspecified.

replicates

A numeric indicating the number of replicate simulations to use for each value of τ. Defaults to 1e5.

summary

A logical variable indicating whether a summary of the function's progress should be printed to the console. Defaults to FALSE.

Value

A list containing the following elements

  • A tibble in the slot $sim giving the estimated operating characteristics.

  • Each of the input variables.

See Also

build_ss_norm, des_ss_norm, opchar_ss_norm, plot.multiarm_des_ss_norm.

Examples

## Not run: 
# The estimated operating characteristics for the default parameters
sim   <- sim_ss_norm()
# An A-optimal design, specifying tau explicitly
des_A <- des_ss_norm(ratio = "A", integer = T)
sim_A <- sim_ss_norm(des_A, rbind(c(0, 0),
                                  c(0.5, 0.5),
                                  c(0.5, 0),
                                  c(0, 0.5)))

## End(Not run)

mjg211/multiarm documentation built on Jan. 19, 2024, 8:21 a.m.