summary.vectorIndex: Summarize a vectorIndex/VI object

In bjbiggerstaff/PooledInfRate: Estimation for Pooled or Group Testing

Summarize a vectorIndex/VI object

Description

The functions provide more detail underlying the results from vectorIndex/VI

Usage

## S3 method for class 'vectorIndex'
summary(object, simple = FALSE, ...)
## S3 method for class 'VI'
summary(object, simple = FALSE, ...)

## S3 method for class 'summary.vectorIndex'
print(x, ...)
## S3 method for class 'summary.VI'
print(x, ...)

Arguments

object	an object of class vectorIndex/VI
...	for additional arguments
x	an object of class summary.vectorIndex/summary.VI
simple	logical. If TRUE return a data frame with groups and species-specific summaries used in computing the vector; if FALSE return a more complete description of the call.

Details

In addition to the estimates, details including the vector indices for the individual species by group.

Value

The original vectorIndex or VI object with additional list elements

...	future arguments

and attributes class and call.

If simple = TRUE, a data frame of the group and species-specific summary information is returned.

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.