checkFFFMeanCDargs: Check the arguments for FFF change detection initialisation

In ffstream: Forgetting Factor Methods for Change Detection in Streaming Data

Check the arguments for FFF change detection initialisation

Description

A function which will do all the checks for FFFcd, check the parameters are in the proper ranges, etc. Does not return any values.

Usage

checkFFFMeanCDargs(alpha, lambda, BL, functionName = "")

Arguments

alpha	The value of the threshold. Must be finite, in (0,1), etc.
lambda	The value of the FFF. Must be finite, in range [0,1], etc.
BL	The value of the burn-in length. Must be finite, above 0, etc.
functionName	The name of the original function which is being called to check the parameters. Will help user with debugging. Default is "", in which case no function name will be displayed.

Value

The truncated burn-in length (since it must be an integer).

ffstream documentation built on May 31, 2023, 7:53 p.m.