ucControl: Algorithm variables used by uncondExact2x2.

Description Usage Arguments Value Examples

View source: R/uncondExact2x2.R

Description

Function that gives list of algorithm variables used by uncondExact2x2.

Usage

1
2
3
ucControl(nCIgrid = 500, errbound = 0, nPgrid = 100, 
   power2 = 20, maxPgridRatio = 1 - 10^-6, 
   minPgridRatio = 10^-6)

Arguments

nCIgrid

number of elements in the grid search for the confidence interval.

errbound

Used with large sample sizes to speed calculations, only calculate univariate binomial distribution in the middle part, exclude both tails with less than errbound/2 in each tail. When errbound=0, calculate the full distributions.

nPgrid

number of elements to search over the null parameter space.

power2

how precise to make the grid search for the confidence interval when using the ‘faster’ algorithm (e.g., when method='user-fixed').

maxPgridRatio

maximum binomial probability for the search over the null nuisance parameter space, when parmtype='ratio' or 'oddsratio'

minPgridRatio

maximum binomial probability for the search over the null nuisance parameter space, when parmtype='ratio' or 'oddsratio'

Value

A LIST of all the named elements (see arguments to call).

Examples

1
ucControl(errbound=10^-5)

Example output

Loading required package: exactci
Loading required package: ssanv
$nCIgrid
[1] 500

$errbound
[1] 1e-05

$nPgrid
[1] 100

$power2
[1] 20

$maxPgridRatio
[1] 0.999999

$minPgridRatio
[1] 1e-06

exact2x2 documentation built on Dec. 11, 2021, 9:43 a.m.