Learn R Programming
ffstream (version 0.1.7.2)

getInBoundsErrorMessage: Create the error message for a certain parameter outside its bounds

Description

For a particular parameter, create an error message specifying that the parameter is outside its bounds.

Usage

getInBoundsErrorMessage(
  paramName,
  value = NULL,
  lowerBound,
  upperBound,
  algoName = NULL,
  strictly = FALSE,
  functionName = ""
)

Arguments

paramName

Name of parameter, e.g. lambda

value

The value of the non-finite parameter

lowerBound

Lower bound of range, e.g. 0.

upperBound

Upper bound of range, e.g. 1.

algoName

Name of algorithm, e.g. AFF change detector

strictly

Use "[" or "(" strictly=FALSE means "[" and strictly=TRUE means "("

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.