bi_pair_correlation: Bivariate Pair Correlation Function

View source: R/bi_pair_correlation.R

bi_pair_correlationR Documentation

Bivariate Pair Correlation Function

Description

Bivariate Pair Correlation Function

Usage

bi_pair_correlation(
  mif,
  mnames,
  r_range = NULL,
  num_permutations = 100,
  edge_correction = "translation",
  keep_permutation_distribution = FALSE,
  workers = 1,
  overwrite = FALSE,
  xloc = NULL,
  yloc = NULL,
  ...
)

Arguments

mif

object of class 'mif'

mnames

character vector or dataframe with 2 columns containing markers/marker combinations to run

r_range

numeric vector radii to measure

num_permutations

integer for the number of permutations to run

edge_correction

character string for which edge correction to implement for Ripley's K

keep_permutation_distribution

boolean whether to summarise the permutations or keep all

workers

integer for number of cores to use when calculating

overwrite

boolean for whether to overwrite existing bivariate pair correlation results

xloc

x location column in spatial files

yloc

y location column in spatial files

...

other variables to pass to '[spatstat.explore::pcfcross]'

Value

'mif' object with the bivariate_pair_correlation slot filled


spatialTIME documentation built on June 22, 2024, 10:35 a.m.