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

Description Usage Arguments Value

View source: R/check.R

Description

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

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
checkSpeeds(
  movements,
  tag,
  detections,
  valid.movements,
  speed.warning,
  speed.error,
  GUI,
  save.tables.locally,
  n
)

Arguments

movements

The movements table for a specific tag.

tag

The tag being analysed.

detections

The detections data.frame for a specific tag.

valid.movements

The valid movements table for a specific tag.

speed.warning

If a tag 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 tag 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".

save.tables.locally

Logical: If a table must be temporarily stored into a file for user inspection, should it be saved in the current working directory, or in R's temporary folder?

n

A string indicating the overall progress.

Value

A list of movements with updated 'Valid' columns


actel documentation built on Jan. 6, 2021, 1:07 a.m.