checkSMovesN: Verify number of detections in section movements

View source: R/check.R

checkSMovesNR Documentation

Verify number of detections in section movements

Description

Verify number of detections in section movements

Usage

checkSMovesN(
  secmoves,
  tag,
  section.warning,
  section.error,
  GUI,
  save.tables.locally,
  n
)

Arguments

secmoves

the section movements list.

tag

The tag being analysed.

section.warning

If a tag has section movement events with less or equal to section.warning detections, a warning is issued. Defaults to 1. To disable section warnings, set to 0. Must be equal to or greater than section.error.

section.error

If a tag has section movement events with less or equal to section.error detections, user intervention is suggested. Defaults to 1. To disable user intervention suggestions, set to 0.

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 section movements with updated 'Valid' columns


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