summary.spscan: Summarize object from 'spscan.test'.

In smacpod: Statistical Methods for the Analysis of Case-Control Point Data

Summarize object from spscan.test.

Description

Summarize object of class scan from spscan.test.

Usage

## S3 method for class 'spscan'
summary(object, ..., idx = seq_along(object$clusters), digits = 1)

Arguments

object	An spscan object.
...	Arguments passed on to base::summary, base::summary
idx	An index vector indicating the elements of object$clusters to print information for. The default is all clusters.
digits	Integer indicating the number of decimal places.

Value

Returns/prints a data frame. Each row of the data frame summarizes the centroid of each cluster, the cluster radius, the number of events in the cluster, the number of cases in the cluster, the expected number of cases in the cluster, the relative risk of the cluster (cases/events in cluster)(cases/events outside cluster), the natural logarithm of the test statistic, and the associated p-value.

Examples

data(grave)
out = spscan.test(grave, nsim = 99, alpha = 0.8)
summary(out)

smacpod documentation built on Sept. 22, 2023, 1:06 a.m.