kin_pair_simulation: KinPairSimulation

In kindisperse: Simulate and Estimate Close-Kin Dispersal Kernels

Description

KinPairSimulation

Usage

kin_pair_simulation(
  data = NULL,
  kinship = NULL,
  lifestage = NULL,
  simtype = NULL,
  kerneltype = NULL,
  posigma = NULL,
  initsigma = NULL,
  breedsigma = NULL,
  gravsigma = NULL,
  ovisigma = NULL,
  customsigma = NULL,
  simdims = NULL,
  kernelshape = NULL,
  cycle = NULL,
  call = NULL,
  filtertype = NULL,
  upper = NULL,
  lower = NULL,
  spacing = NULL,
  samplenum = NULL,
  sampledims = NULL,
  model = NULL
)

Arguments

data	tbl_df. tibble of simulation values
kinship	character - one of PO, FS, HS, AV, HAV, GG, 1C, H1C, GAV, HGAV, 1C1, H1C1, GGG, 2C, and H2C.
lifestage	character - one of 'unknown', 'immature' or 'ovipositional'
simtype	character - simulation type
kerneltype	character. - 'Gaussian', 'Laplace' or 'vgamma' (variance-gamma)
posigma	numeric - overall value of dispersal sigma (for simple kernel)
initsigma	numeric. - value of pre-breeding dispersal sigma (for composite kernel)
breedsigma	numeric. - value of breeding dispersal sigma (for composite kernel)
gravsigma	numeric. - value of post-breeding dispersal sigma (for composite kernel)
ovisigma	numeric. - value of oviposition dispersal sigma (for composite kernel)
customsigma	numeric. - vector of named custom dispersal sigmas (for custom kernel)
simdims	numeric. - dimensions of sampling area (assumes one side of square)
kernelshape	numeric. - value of kernel shape of simulation (if using kernel with shape parameter e.g. vgamma)
cycle	integer - number of breeding cycles sampled individual has survived (for custom kernel)
call	call. Call to create object
filtertype	character. whether the initial sim has been further filtered
upper	numeric. - FILTER: upper threshold used
lower	numeric. - FILTER: lower threshold used
spacing	numeric. - FILTER: spacing used
samplenum	numeric. - FILTER: sample number used
sampledims	numeric. - FILTER: sample dimensions used
model	list - model information if custom simulation used to generate object

Value

returns an object of class KinPairSimulation.

Examples

kin_pair_simulation()

kindisperse documentation built on July 28, 2021, 5:09 p.m.