itmsa (version 0.1.0)

itm: Information-Theoretic Measures for Spatial Association

Description

Information-Theoretic Measures for Spatial Association

Usage

itm(
  formula,
  data,
  method = c("vm", "icm"),
  beta = 1,
  unit = c("e", "2", "10"),
  seed = 42,
  permutation_number = 999
)

Value

A tibble.

Arguments

formula

A formula.

data

A data.frame, tibble or sf object of observation data.

method

(optional) whether vm(default) or icm.

beta

(optional) The \(\beta\) value used fo vm measure, default is 1.

unit

(optional) Logarithm base, default is e.

seed

(optional) Random number seed, default is 42.

permutation_number

(optional) Number of Random Permutations, default is 999.

Examples

sim = readr::read_csv(system.file('extdata/sim.csv',package = 'itmsa'))
# \donttest{
# Information-theoretical V-measure
itm(z1 ~ z2, data = sim, method = 'vm')
# Information Consistency-Based Measures
itm(z1 ~ z2, data = sim, method = 'icm')
# }