sim_par: Control Values for 'simulate'.

View source: R/sim_par.R

sim_parR Documentation

Control Values for simulate.

Description

sim_par defines the simulation parameters & control scenarios used by simulate.

Usage

sim_par(
  move = c("brw", "rw", "drift"),
  temp = TRUE,
  advect = TRUE,
  noise = NULL,
  growth = TRUE,
  shelf = TRUE,
  scenario = "rs",
  land = FALSE,
  boundary = FALSE,
  ...
)

Arguments

move

"brw" a biased RW; "rw" simple RW; "drift" no active swimming

temp

logical

advect

logical

noise

numeric; add small random component to u,v vectors - only applies when mode = "drift"

growth

logical

shelf

logical; should smolts be constrained to stay in water > - 1000 m depth (continental shelf)

land

keep track of sim rep hitting land (TRUE)

boundary

keep track of sim rep hitting sim boundary (TRUE)

...

additional simulation control parameters

migs

migration scenario 1 or 2 (stop migration upon arrival to Grand Banks)

Details

The movement process used predominantly in the simulation is selected by the move argument. Additional parameters include: temp is movement temperature-dependent; advect do ocean currents influence movement; growth do smolts grow in temp-dependent fashion; start.date; start (location); coa centre of attraction (can be NULL); mdir directional bias (a 2-element vector); rho concentration of step directions (for wrapped-Cauchy, a 2-element vector); ...

Value

Returns a list with components

move

the main move process

temp

temperature-dependent movements

advect

ocean-current-dependent movements

noise

add random noise to current u,v values

growth

temperature-dependent growth

shelf

movements constrained to stay on shelf

migs

migration strategy

land

record if smolt gets "stuck" on land, thereby ending simulation

boundary

record if smolt hits simulation boundary, thereby ending simulation

pars

list of additional, required control parameters


ianjonsen/simsmolt documentation built on July 11, 2022, 12:29 p.m.