computeMinEsBatchSafeZ {safestats}

Computes the smallest mean difference that is detectable with chance 1-beta, for the provided sample size

Description

Computes the smallest mean difference that is detectable with chance 1-beta, for the provided sample size

Usage

computeMinEsBatchSafeZ(
  nPlan,
  alpha = 0.05,
  beta = 0.2,
  sigma = 1,
  kappa = sigma,
  alternative = c("twoSided", "greater", "less"),
  testType = c("oneSample", "paired", "twoSample"),
  parameter = NULL,
  maxIter = 10
)

Arguments

nPlan

optional numeric vector of length at most 2. When provided, it is used to find the safe test defining parameter phiS. Note that if the purpose is to plan based on nPlan alone, then both meanDiffMin and beta should be set to NULL.

alpha

numeric in (0, 1) that specifies the tolerable type I error control –independent on n– that the designed test has to adhere to. Note that it also defines the rejection rule e10 > 1/alpha.

beta

numeric in (0, 1) that specifies the tolerable type II error control necessary to calculate both "n" and "phiS". Note that 1-beta defines the power.

sigma

numeric > 0 representing the assumed population standard deviation used for the test.

kappa

the true population standard deviation. Default kappa=sigma.

alternative

a character string specifying the alternative hypothesis must be one of "twoSided" (default), "greater" or "less".

testType

either one of "oneSample", "paired", "twoSample".

parameter

optional test defining parameter. Default set to NULL.

maxIter

maximum number of iterations in the optimisation process for two-sided designs

Value

numeric > 0 that represents the minimal detectable mean difference