actel (version 1.1.0)

checkSpeeds: check fish speeds against defined thresholds (in m/s)

Description

check fish speeds against defined thresholds (in m/s)

Usage

checkSpeeds(movements, fish, valid.movements, speed.warning, speed.error, GUI)

Arguments

movements

The movements table

fish

The fish being analysed

valid.movements

The valid movements table

speed.warning

If a fish moves at a speed equal or greater than speed.warning (in metres per second), a warning is issued. If left NULL (default), no warnings are issued.

speed.error

If a fish moves at a speed equal or greater than speed.error (in metres per second), user intervention is suggested. If left NULL (default), user intervention is never suggested.

GUI

One of "needed", "always" or "never". If "needed", a new window is opened to inspect the movements only if the movements table is too big to be displayed in R's console. If "always", a graphical interface is always created when the possibility to invalidate events emerges. If "never", a graphical interface is never invoked. In this case, if the table to be displayed does not fit in R's console, a temporary file will be saved and the user will be prompted to open and examine that file. Defaults to "needed".

Value

A list of movements with updated 'Valid' columns