summary.matchedwake: Summary Function for Objects of Class 'matchedwake'

View source: R/mwa.R

summary.matchedwakeR Documentation

Summary Function for Objects of Class matchedwake

Description

Overloads the default summary() for objects of class matchedwake.

Usage

## S3 method for class 'matchedwake'
summary(object, detailed = FALSE, ...)

Arguments

object

object of class matchedwake.

detailed

Boolean indicating whether or not a detailed summary should be returned. Default = TRUE.

...

further arguments passed to or from other methods.

Value

Returns a data.frame with an overview of all significant results (significance level is alpha1 as retrieved from x$parameters). If detailed = TRUE this overview includes a number of matching statistics and statistics on overlaps of the spatiotemporal cylinders. If additional control dimensions were included in the estimation, it also provides an overview of the corresponding coefficients and p values for all significant results.

Author(s)

Sebastian Schutte and Karsten Donnay.

References

Schutte, S., Donnay, K. (2014). “Matched wake analysis: Finding causal relationships in spatiotemporal event data.” Political Geography 41:1-10.

See Also

matchedwake


mwa documentation built on April 26, 2022, 5:07 p.m.