spade {gdverse}R Documentation

spatial association detector (SPADE) model

Description

Function for spatial association detector (SPADE) model.

Usage

spade(
  formula,
  data,
  wt = NULL,
  locations = NULL,
  discnum = NULL,
  discmethod = NULL,
  cores = 1,
  seed = 123456789,
  permutations = 0,
  ...
)

Arguments

formula

A formula of spatial association detector (SPADE) model.

data

A data.frame or tibble of observation data.

wt

(optional) The spatial weight matrix. When wt is not provided, must provide locations. And gdverse will use locations columns to construct spatial weight use inverse_distance_weight().

locations

(optional) The spatial location coordinates columns name in data. Useful and must provided when wt is not provided. When wt is provided, locations is not need.

discnum

(optional) Number of multilevel discretization. Default will use 3:22.

discmethod

(optional) The discretization methods. Default all use quantile. Noted that robust will use robust_disc(); rpart will use rpart_disc(); Others use st_unidisc().

cores

(optional) A positive integer(default is 1). If cores > 1, use parallel computation.

seed

(optional) Random number seed, default is 123456789.

permutations

(optional) The number of permutations for the PSD computation. Default is 0, which means no pseudo-p values are calculated.

...

(optional) Other arguments passed to st_unidisc(),robust_disc() or rpart_disc().

Value

A list of the SPADE model result.

factor

the result of SPADE model

Note

The columns in the locations part of data are only used to construct spatial weight matrix when wt is NULL, and are not considered as explanatory variables. If you need to include spatial locations as explanatory variables, build a spatial weight matrix ahead of time, leaving the locations parameter to NULL.The most recommended method is to explicitly specify all variables in formula instead of using .!

Author(s)

Wenbo Lv lyu.geosocial@gmail.com

References

Xuezhi Cang & Wei Luo (2018) Spatial association detector (SPADE),International Journal of Geographical Information Science, 32:10, 2055-2075, DOI: 10.1080/13658816.2018.1476693

Examples

data('sim')
g = spade(y ~ ., data = sim,
          locations = c('lo','la'),
          discvar = c("xa","xb","xc"))
g


[Package gdverse version 1.0.0 Index]