calcStatsCollEvents: Calculate statistics of collective events

View source: R/calcStatsCollEvents.R

calcStatsCollEventsR Documentation

Calculate statistics of collective events

Description

Calculate statistics of collective events identified by the trackCollEvents function. Calculates: - event duration in time frames, clDur, - the total number of unique objects/cells that participate in an event, totSz, - the smallest number of objects/cells that comprise an event, minSz, - the largest number of objects/cells that comprise an event, maxSz.

Usage

calcStatsCollEvents(
  inDTcoll,
  inCols = list(frame = "frame", id = "trackID", collid = "clTrackID", bootiter =
    "bootiter"),
  fromBoot = FALSE
)

Arguments

inDTcoll

a data.table with collective events in the long format produced by the trackCollEvents function. Consists of 3 columns: integer frame number, object id, id's of collective events.

inCols

a list with column names, list(frame = , id = , collid = , bootiter =), that correspond to the integer frame number, object id, id of collective events, and bootstrapping iteration, respectively.

fromBoot

logical, indicates whether input data comes from bootstrapping; default FALSE.

Value

a data.table with aggregated stats of collective events.

Examples

cat("no examples")

dmattek/ARCOS documentation built on Dec. 5, 2024, 11:02 p.m.