R/localG-star.R

In JosiahParry/sfdep: Spatial Dependence for Simple Features

#' Local G*
#'
#' Calculate the local Gi* statistic.
#'
#' @inheritParams local_g
#' @export
#' @examples
#' nb <- st_contiguity(guerry)
#' wt <- st_weights(nb)
#' x <- guerry$crime_pers
#'
#' res <- local_gstar_perm(x, nb, wt)
#' head(res)
#'
#' res <- local_gstar(x, nb, wt)
#' head(res)
#' @returns a `data.frame` with columns:
#'
#' - `gi`: the observed statistic
#' - `e_gi`: the permutation sample mean
#' - `var_gi`: the permutation sample variance
#' - `p_value`: the p-value using sample mean and standard deviation
#' - `p_folded_sim`: p-value based on the implementation of Pysal which always assumes a two-sided test taking the minimum possible p-value
#' - `skewness`: sample skewness
#' - `kurtosis`: sample kurtosis
local_gstar <- function(x, nb, wt, alternative = "two.sided", ...) {
  if (is.null(attr(nb, "self.included"))) {
    nb <- spdep::include.self(nb)
    wt <- st_weights(nb)
  }
  suppressMessages({
    local_g(x, nb, wt, alternative = alternative, ...)
  })

}

#' @inheritParams local_g_perm
#' @export
#' @rdname local_gstar
local_gstar_perm <- function(x, nb, wt, nsim = 499, alternative = "two.sided", ...) {
  if (is.null(attr(nb, "self.included"))) {
    nb <- spdep::include.self(nb)
    wt <- st_weights(nb)
  }

  suppressMessages({
    res <- local_g_perm(x, nb, wt, nsim = nsim, alternative = alternative, ...)
  })

  colnames(res)[1] <- "gi_star"

  res
}