| InitScan {HDSpatialScan} | R Documentation |
Initalization of the scan procedures by creating the matrix of potential clusters
Description
This function initializes the scan procedures by creating the matrix of potential clusters.
Usage
InitScan(
mini_post,
maxi_post,
type_minimaxi_post,
sites_areas,
sites_coord,
system,
mini,
maxi,
type_minimaxi
)
Arguments
mini_post |
numeric. A minimum to filter the significant clusters a posteriori (see type_minimaxi_post). The default NULL is for no filtering with a a posteriori minimum. |
maxi_post |
numeric. A maximum to filter the significant clusters a posteriori (see type_minimaxi_post). The default NULL is for no filtering with a a posteriori maximum. |
type_minimaxi_post |
character. Type of minimum and maximum a posteriori: by default "sites/indiv": the mini_post and maxi_post are on the number of sites or individuals in the significant clusters. Other possible values are "area": the minimum and maximum area of the clusters, or "radius": the minimum and maximum radius. |
sites_areas |
numeric vector. Areas of the sites. It must contain the same number of elements than the rows of sites_coord. If the data is on individuals and not on sites, there can be duplicated values. 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). |
system |
character. System in which the coordinates are expressed: "Euclidean" or "WGS84". |
mini |
integer. A minimum for the clusters (see type_minimaxi). Changing the default value may bias the inference. |
maxi |
integer. A Maximum for the clusters (see type_minimaxi). Changing the default value may bias the inference. |
type_minimaxi |
character. Type of minimum and maximum: by default "sites/indiv": the mini and maxi are on the number of sites or individuals in the potential clusters. Other possible values are "area": the minimum and maximum area of the clusters, or "radius": the minimum and maximum radius. |
Value
The list of the following elements:
filtering_post: logical, is there an a posteriori filtering?
matrix_clusters: the matrix of potential clusters
centres: the coordinates of the centres of each potential cluster
radius: the radius of the potential clusters in km if system = WGS84 or in the user units
areas: the areas of the potential clusters (in the same units as sites_areas).
sites_coord: coordinates of the sites
system: system in which the coordinates are expressed
mini_post: a minimum to filter the significant clusters a posteriori
maxi_post: a maximum to filter the significant clusters a posteriori
type_minimaxi_post: type of minimum and maximum a posteriori