agentAnalysis {alcyon}

Agent Analysis

Description

Runs Agent Analysis on the given PointMap

Usage

agentAnalysis(
  pointMap,
  timesteps,
  releaseRate,
  agentLifeTimesteps,
  agentFov,
  agentStepsToDecision,
  agentLookMode,
  originX = NA,
  originY = NA,
  locationSeed = 0L,
  numberOfTrails = NA,
  getGateCounts = FALSE,
  copyMap = TRUE,
  verbose = FALSE,
  progress = FALSE
)

Arguments

pointMap

A PointMap, used as an exosomatic visual map for agents to take exploratory information

timesteps

Number of total system timesteps.

releaseRate

Agent release rate (likelihood of release per timestep).

agentLifeTimesteps

Agent total lifetime (in timesteps)

agentFov

Agent field-of-view (out of 32 bins = 360).

agentStepsToDecision

Agent steps before turn decision.

agentLookMode

The agent look mode. See AgentLookMode

originX

Agent starting points (x coordinates).

originY

Agent starting point (y coordinates).

locationSeed

Agents to start at random locations with specific seed (0 to 10). Default is 0.

numberOfTrails

Record trails for this amount of agents (set to 0 to record all, with max possible currently = 50).

getGateCounts

Get values at gates

copyMap

Optional. Copy the internal sala map

verbose

Optional. Show more information of the process.

progress

Optional. Show process progress.

Value

Returns a list with:

• newAttributes: The new attributes that were created during the process

• trailMap: A ShapeMap with trails if numberOfTrails was set over 0

Examples

mifFile <- system.file(
    "extdata", "testdata", "simple",
    "simple_interior.mif",
    package = "alcyon"
  )
  sfMap <- st_read(mifFile,
    geometry_column = 1L, quiet = TRUE
  )
  pointMap <- makeVGAPointMap(
    sfMap,
    gridSize = 0.5,
    fillX = 3.0,
    fillY = 6.0,
    maxVisibility = NA,
    boundaryGraph = FALSE,
    verbose = FALSE
  )
agentAnalysis(
  pointMap,
  timesteps = 3000L,
  releaseRate = 0.1,
  agentStepsToDecision = 3L,
  agentFov = 11L,
  agentLife = 1000L,
  agentLookMode = AgentLookMode$Standard,
  originX = NA,
  originY = NA,
  locationSeed = 1L,
  numberOfTrails = 50L,
  getGateCounts = FALSE,
  verbose = FALSE
)