summary.ResScanOutputMulti: Summary of the clusters obtained with a multivariate scan...

In HDSpatialScan: Multivariate and Functional Spatial Scan Statistics

Summary of the clusters obtained with a multivariate scan function (MG or MNP).

Description

This function gives a summary of the clusters in a table

Usage

## S3 method for class 'ResScanOutputMulti'
summary(
  object,
  type_summ = "param",
  digits = 3,
  quantile.type = 7,
  only.MLC = FALSE,
  ...
)

Arguments

object	ResScanOutputMulti. Output of a multivariate scan function (MG or MNP).
type_summ	character. "param" or "nparam". "param" gives the mean and the sd for each variable in the clusters, outside, and globally and "nparam" gives the Q25, Q50 and Q75 quantiles for each variables in the clusters, outside, and globally.
digits	integer. Number of decimals in output.
quantile.type	An integer between 1 and 9 (see function quantile). Ignored if type_summ is "param"
only.MLC	logical. Should we summarize only the MLC or all the significant clusters?
...	Further arguments to be passed to or from methods.

Value

No value returned, displays the results in the console

Examples

library(sp)
data("map_sites")
data("multi_data")
coords <- coordinates(map_sites)
res_mg <- SpatialScan(method = "MG", data=multi_data, sites_coord = coords,
system = "WGS84", mini = 1, maxi = nrow(coords)/2)$MG
summary(object = res_mg)

HDSpatialScan documentation built on May 31, 2023, 7:52 p.m.