Skip to contents

Settle Particles

Source: R/settle_particles.R
settle_particles.Rd

Function to determine probability of settlement if particles pass suitable substrate. Options:

  • "additive": settle somewhere in habitat intersect regardless of time

  • "lagged": sample first 10 minutes of habitat entry

  • "rapid": settle at first habitat intersect

Usage

settle_particles(
  input,
  seascape = seascape,
  probability = "additive",
  silent = TRUE,
  return.plot = FALSE,
  subsample = NULL,
  seed.value = NULL,
  ...
)

Arguments

input

output from seed_particles() or directly a particle sf object

seascape

sf object from seascape_probability(), for plotting base

probability

settlement rule, one of "additive", "rapid", or "lagged"

silent

suppress printed output (default TRUE)

return.plot

whether to return tmap plot output

subsample

optionally sample N particles for faster plotting

seed.value

set seed for reproducibility

...

additional args