ResScanOutputMulti: Constructor function for objects of the ResScanOutputMulti...

In HDSpatialScan: Multivariate and Functional Spatial Scan Statistics

Constructor function for objects of the ResScanOutputMulti class

Description

This is the constructor function for objects of the ResScanOutputMulti class which inherits from class ResScanOutput.

Usage

ResScanOutputMulti(
  sites_clusters,
  pval_clusters,
  centres_clusters,
  radius_clusters,
  areas_clusters,
  system,
  variable_names = NULL,
  sites_coord,
  data,
  method
)

Arguments

sites_clusters	list. List of the indices of the sites of the selected clusters.
pval_clusters	numeric vector. The pvalues of the selected clusters.
centres_clusters	numeric matrix. Coordinates of the centres of the selected clusters.
radius_clusters	numeric vector. Radius of the selected clusters.
areas_clusters	numeric vector. Areas of the selected clusters.
system	character. System in which the coordinates are expressed: "Euclidean" or "WGS84".
variable_names	character. Names of the variables. By default NULL.
sites_coord	numeric matrix. Coordinates of the sites (or the individuals, in that case there can be many individuals with the same coordinates).
data	matrix. Matrix of the data, the rows correspond to the sites (or to the individuals) and each column represents a variable.
method	character. The scan procedure used.

Value

An object of class ResScanOutputMulti which is a list of the following elements:

• sites_clusters: List of the indices of the sites of the selected clusters.

• pval_clusters: The pvalues of the selected clusters.

• centres_clusters: Coordinates of the centres of the selected clusters.

• radius_clusters: Radius of the selected clusters.

• areas_clusters: Areas of the selected clusters.

• system: System in which the coordinates are expressed: "Euclidean" or "WGS84".

• sites_coord: Coordinates of the sites (or the individuals, in that case there can be many individuals with the same coordinates).

• data: Matrix.

• variable_names: names of the variables.

• method: The scan procedure used.

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