checkEpsilon: Epsilon Parameter Check

Description Usage Arguments Value Examples

View source: R/utilities-data-validation.R View source: R/utilities-input-validation.R

Description

Utility function for checking that epsilon is acceptably defined.

Utility function for checking that epsilon is acceptably defined.

Usage

1
2
3
checkEpsilon(epsilon, expectedLength = 1)

checkEpsilon(epsilon, expectedLength = 1)

Arguments

epsilon

A vector, that ought to be positive and of length one.

expectedLength

Integer value. Specifies how long the output ought to be.

epsilon

A vector, that ought to be positive.

multipleEps

A boolean value. If TRUE, multiple epsilon paramaters may be defined. Default to FALSE.

Value

The supplied epsilon if acceptable, otherwise an error message interupts.

The supplied epsilon if acceptable, otherwise an error message interupts.

Examples

1
2
3
checkEpsilon(0.1)
## Not run: checkEpsilon(-2)
## Not run: checkEpsilon(c(0.1,0.5))

privacytoolsproject/PSI-Library documentation built on Feb. 17, 2020, 2:03 p.m.