isZeroScalar: Wrapper for the checkarg function, using specific parameter...

In checkarg: Check the Basic Validity of a (Function) Argument

Description

This function can be used in 3 ways:

1. Return TRUE or FALSE depending on whether the argument checks are passed. This is suitable e.g. for if statements that take further action if the argument does not pass the checks.
   

2. Throw an exception if the argument does not pass the checks. This is suitable e.g. when no further action needs to be taken other than throwing an exception if the argument does not pass the checks.
   

3. Same as (2) but by supplying a default value, a default can be assigned in a single statement, when the argument is NULL. The checks are still performed on the returned value, and an exception is thrown when not passed.
   

Usage

isZeroScalar(argument, default = NULL, stopIfNot = FALSE, message = NULL,
  argumentName = NULL)

Arguments

argument	See checkarg function.
default	See checkarg function.
stopIfNot	See checkarg function.
message	See checkarg function.
argumentName	See checkarg function.

Details

Actual call to checkarg: checkarg(argument, "N", default = default, stopIfNot = stopIfNot, nullAllowed = FALSE, n = 1, zeroAllowed = TRUE, negativeAllowed = FALSE, positiveAllowed = FALSE, nonIntegerAllowed = TRUE, naAllowed = FALSE, nanAllowed = FALSE, infAllowed = FALSE, message = message, argumentName = argumentName)

Value

See checkarg function.

Examples

isZeroScalar(0)
   # returns TRUE (argument is valid)
isZeroScalar("X")
   # returns FALSE (argument is invalid)
#isZeroScalar("X", stopIfNot = TRUE)
   # throws exception with message defined by message and argumentName parameters

checkarg documentation built on May 2, 2019, 3:26 p.m.