summary.pooledBin: Summarize a pooledBin/pIR or pooledBinList/pIRList objects

In bjbiggerstaff/PooledInfRate: Estimation for Pooled or Group Testing

Summarize a pooledBin/pIR or pooledBinList/pIRList objects

Description

The functions provide more detail underlying the results from pooledBin/pIR

Usage

## S3 method for class 'pooledBin'
summary(object, simple = FALSE, ...)
## S3 method for class 'pIR'
summary(object, simple = FALSE, ...)

## S3 method for class 'summary.pooledBin'
print(x, ...)
## S3 method for class 'summary.pIR'
print(x, ...)



## S3 method for class 'summary.pooledBin'
x[i, j, drop = if (missing(i)) TRUE else length(cols) ==  1]
## S3 method for class 'summary.pIR'
x[i, j, drop = if (missing(i)) TRUE else length(cols) ==  1]

Arguments

object	an object of class pooledBin/pIR
...	for additional arguments
x	an object of class summary.pooledBin/summary.pIR
simple	logical. If TRUE return a data frame with estimates, confidence intervals, total number of individuals, number of positive pools, and scale, by group; if FALSE return a more complete description of the call.
i,j	elements to extract or replace. For [ and [[, these are numeric or character or, for [ only, empty or logical. Numeric values are coerced to integer as if by as.integer.
drop	logical. If TRUE the result is coerced to the lowest possible dimension. The default is to drop if only one column is left, but not to drop if only one row is left.

Details

In addition to the estimates and confidence intervals, details including the total number of individuals included, the number of pools, and the number of "positive" pools are given. Printing the result reports these, along with which point and confidence interval methods were used and the call.

The subsetting or extractor functions [.pooledBin and [.pIR mimic the same [ behavior as with data frames.

Value

The original pooledBin or pIR object with additional list elements

scale	scale of estimates, with default 1
pt.method	the specified point estimate method to be used
ci.method	the specified confidence interval methods to be used
...	future arguments

and attributes class and call.

Author(s)

Brad Biggerstaff

See Also

See also pooledBin, pIR

Examples

x <- c(1,0,0,0)
m <- c(50,25,10,5)

pb <- pooledBin(x,m)
summary(pb)

bjbiggerstaff/PooledInfRate documentation built on Jan. 19, 2024, 6:54 p.m.