checkAFFMeanCDargs: Check the arguments for AFF mean change detector

Description Usage Arguments

View source: R/errorMessage.R

Description

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

Usage

1
checkAFFMeanCDargs(alpha, eta, BL, functionName = "")

Arguments

alpha

The value of the threshold. Must be finite, in (0,1), etc.

eta

The value of the step size in the gradient descent. 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.


ffstream documentation built on May 29, 2017, 10:33 p.m.

Search within the ffstream package
Search all R packages, documentation and source code