Binomial Power and Sample Size Dialog

DESCRIPTION:

Interface between dialog and binomial.sample.size function.

USAGE:

menuBinomialPower(compute.what, sample.type, prop1.null, prop2.null, prop1.alt,  
    prop2.alt, alpha, power, n1, n2, prop.n2, test.type, print.results,  
    expand.args, exact.n, recompute.power, interactive, correct, columns, 
    digits, save.summary, export.summary, show.p = .Options$show.data.in.view)  

REQUIRED ARGUMENTS:

compute.what
One of "Sample Size", "Power" or "Min. Difference".
sample.type
One of "One Sample", "Two Sample" or "Paired".

OPTIONAL ARGUMENTS:

prop1.null
The null proportion in a one-sample test.
prop2.null
The group 1 proportion a two-sample or paired test.
prop1.alt
The alternative proportion in a one-sample test.
prop2.alt
The group 2 proportion in a two-sample or paired test.
alpha
The desired alpha level - probability of a Type I error. Default is 0.05.
power
The desired power level. Default is 0.80.
n1
Sample size for first group.
n2
Second sample size in two-sample test. Default is equal to n1.
prop.n2
Proportion of n2 to n1: n2 = prop.n2 * n1. Default is 1.
test.type
Nature of alternative hypothesis. One of "two.sided", "greater", "less".
print.results
If TRUE, the resulting data.frame will be printed to the report window.
expand.args
If TRUE, the input arguments will be expanded to build a cross-product table. If FALSE, it is assumed the input is matched, and will only be replicated to the length of the longest vector. Default is TRUE.
exact.n
If TRUE, the computed sample size will not be rounded up.
recompute.power
If TRUE, after the sample size is computed, the power will be recomputed. This is only advantageous when the sample size is rounded up. Default is FALSE.
interactive
If TRUE (default), the resulting values will be written to the appropriate field in the dialog.
columns
A vector of column numbers for the printed output. This determines which columns are printed and in what order.
digits
A vector of digits for rounding each column. If digits is not the same length as columns, it will be reped (or truncated) to match.
save.summary
A character string. If supplied, the printed table will also be saved as an object in the working directory. This is useful if coulmns and digits were used to customize the output.
export.summary
A character string. If supplied the printed table will be written as a tab-delimited ASCII file.
show.p
If TRUE and save.summary is specified, the saved data.frame will be displayed in a Data window.

VALUE:

The output of binomial.sample.size.

SIDE EFFECTS:

The dialog window is modified if interactive is TRUE. The objects save.as and save.summary will be created. If export.summary provided, an ascii file is created.

SEE ALSO:

,