stopTable {binseqtest}

Create data frame with statistics for stopping boundary

Description

Takes boundEst object and creates data frame with p-values and confidence intervals for stopping points between Nmin and Nmax.

Usage

stopTable(object, Nrange = c(0,Inf), 
    Srange=c(0,Inf),output="all",file="stopTableOutput.csv")

## S3 method for class 'stopTable'
print(x,digits=c(3,5),maxnprint=Inf,...)

Arguments

object

object of class boundEst

Nrange

numeric vector, range of total trials to output boundary points (see details)

Srange

numeric vector, range of successes to output boundary points (see details)

output

character, type of output, 'all','csv', or 'print'

file

character, name of file to output comma separated file

x

object of class 'stopTable'

digits

vector of length 1 or 2, first element is digits to print for estimates and confidence intervals (and p-values if length(digits)=1), second element is digits for p-values

maxnprint

number of rows to print from the table

...

additional arguments to be passed to print function, not needed

Details

Create table with statistics at selected stopping points. The arguments Nrange and Srange select which points to output. If Nrange and Srange is of length 2, then the function selects output within the ranges of the associated N and S values. If Nrange and Srange is of length 1, then the function selects only output with exactly the specified values. Note that because Nrange is the only argument that starts with 'N', then stopTable(object,N=41) and stopTable(oject,Nrange=41) are equivalent. Output is a stopTable object (default), a data.frame (output='data.frame'), or a .csv file (output='csv'). The print.stopTable function is an S3 print function for stopTable objects, i.e., it determines the default printing to screen for those objects.

Value

Either a stopTable object, a data.frame, or a .csv file. The stopTable object is a list with elements

conf.level

confidence level=1-lowerError-upperError

lowerError

c.i. error on lower side

upperError

c.i. error on upper side

nullTheta

probability of success under null hypothesis

binding

character, which boundaries are binding: 'both', 'lower', or 'upper'

alternative

character, alternative hypothesis either 'two.sided', 'less', or 'greater'

table

a data.frame with variables, S,N, estimate, lower (confidence limit), upper (confidence limit), pL (lower one-sided p-value), pU (upper one-sided p-value), pts (two-sided p-value), and UL (character giving part of the boundary: 'lower', 'upper', or 'end')

The data.frame (or .csv file) returns the table element of the stopTable with the other elements added as variables (or columns).