assert_test: Argumente-Check (Testfunktionen)

Description Usage Arguments See Also

View source: R/event.R

Description

Hilfsfunktion zum Ueberpruefen einer Reihe von Argumenten, ob sie mit korrekten Typen und sinnvollen Werten uebergeben wurden. Sobald ein Verstoss festgestellt wird, wird die Ausfuehrung unterbrochen. Da diese Test wiederholt in den Ereignis-Testfunktionen auftreten, wurden sie in diese Funktion ausgelagert.

Usage

1
2
3
4
5
6
7
8
assert_test(
  x_start = 0,
  x_end = 0,
  y_start = 0,
  y_end = 0,
  is_strict = NA,
  threshold_in_sec = 0
)

Arguments

x_start

Vektor mit den Startzeitpunkten von Ereignismenge x.

x_end

Vektor mit den Endzeitpunkten von Ereignismenge x.

y_start

Vektor mit den Startzeitpunkten von Ereignismenge y.

y_end

Vektor mit den Endzeitpunkten von Ereignismenge y.

is_strict

Logischer Wert, ob ein minimaler zeitlicher Abstand zwischen den Ereignissen vorliegen muss, damit sie als angrenzend gelten. Anderenfalls gelten Ereignisse ohne Abstand (d.h. x_end == y_start bzw y_end == x_start ebenfalls als angrenzend (Default: FALSE, d.h. die laxere Definition gilt).

threshold_in_sec

Numerischer Vektor (Laenge 1 oder 2), wie viele Sekunden zwei Ereignisse maximal auseinander liegen duerfen, um noch als angrenzend zu gelten (Toleranzbereich). Bei Laenge 2 wird der erste Wert als Toleranzbereich vor dem Ereignis und der zweite Wert als Toleranzbereich nache dem Ereignis betrachtet. Bei Laenge 1 ist der Toleranzbereich vor und nach dem Ereignis identisch. Sollte Toleranzbereich NA sein, wird er ignoriert.

See Also

Other Argument-Funktionen: assert_sample()


dnlvgt/rktiq documentation built on Jan. 6, 2020, 10:26 p.m.