movement_prob: Movement based on probability

Description Usage Arguments Value

View source: R/move_prob.R

Description

Movement based on probability

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
movement_prob(
  dist_m,
  weights,
  x0,
  y0,
  x_topl,
  y_topl,
  ncells,
  res_m,
  ncols,
  nrows,
  path,
  leave_bounds,
  cells_block,
  cells_out_bounds
)

Arguments

weights

numeric vector, weights to give each grid cell for sampling moves for use with sim_movement_prob; will be length ncells + 1, see cell_weights) for more details. defaults to NULL

x_topl

numeric, the top left x coordinate of the grid on which movement is being simulated

y_topl

numeric, the top left y coordinate of the grid on which movement is being simulated

ncells

numeric, the number of total cells (ncol * nrow)

res_m

numeric, the grid cell resolution in meters

ncols

numeric, the number of columns in the grid

nrows

numeric, the number of rows in the grid

leave_bounds

boolean, are movements to outside of the boundaries of the are being simulated are valid

cells_block

integer vector, the cell ids of grid cells where movements are invalid to, for use with max_tries @param cells_out_bounds integer vector, the cell ids of grid cells which are outside the bounds/ not covered by the area being simulated

Value

list of length 1 with the chosen with sampled cell id, x and y coordinates, whether the movement was to a invalid cell, whether the movement fell within the bounds of the simulation, and the path id for the exposed.


mrajeev08/simrabid documentation built on May 7, 2021, 11:47 a.m.