getTimes: Extract timestamps from the analysis results.

View source: R/get.R

getTimesR Documentation

Extract timestamps from the analysis results.

Description

Extract timestamps from the analysis results.

Usage

getTimes(
  input,
  locations = NULL,
  move.type = c("array", "section"),
  event.type = c("arrival", "departure"),
  n.events = c("first", "all", "last")
)

Arguments

input

An actel results object generated by explore, migration or residency.

locations

The names of the arrays or sections to be included. If left NULL, information for all arrays/sections is extracted.

move.type

The type of events to record: one of "array" or "section".

event.type

The point to be recorded: one of "arrival" or "departure".

n.events

The events to record. One of "first", "all", or "last".

Value

A data frame with the timestamps for each tag (rows) and array (columns)

Examples

# using the example results loaded with actel
getTimes(example.results)

# You can specify which events to extract with 'event.type'
getTimes(example.results, event.type = "arrival")
# or
getTimes(example.results, event.type = "departure")

# and also how many events per tag.
getTimes(example.results, n.events = "first")
# or
getTimes(example.results, n.events = "all")
# or
getTimes(example.results, n.events = "last")


actel documentation built on Oct. 19, 2023, 9:08 a.m.