isStrictlyNegativeNumberOrInfVector {checkarg} | R Documentation |
Wrapper for the checkarg function, using specific parameter settings.
Description
This function can be used in 3 ways:
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.
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.
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
isStrictlyNegativeNumberOrInfVector(argument, default = NULL,
stopIfNot = FALSE, n = NA, message = NULL, argumentName = NULL)
Arguments
argument |
See checkarg function. |
default |
See checkarg function. |
stopIfNot |
See checkarg function. |
n |
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 = NA, zeroAllowed = FALSE, negativeAllowed = TRUE, positiveAllowed = FALSE, nonIntegerAllowed = TRUE, naAllowed = FALSE, nanAllowed = FALSE, infAllowed = TRUE, message = message, argumentName = argumentName)
Value
See checkarg function.
Examples
isStrictlyNegativeNumberOrInfVector(-2)
# returns TRUE (argument is valid)
isStrictlyNegativeNumberOrInfVector("X")
# returns FALSE (argument is invalid)
#isStrictlyNegativeNumberOrInfVector("X", stopIfNot = TRUE)
# throws exception with message defined by message and argumentName parameters
isStrictlyNegativeNumberOrInfVector(-2, default = -1)
# returns -2 (the argument, rather than the default, since it is not NULL)
#isStrictlyNegativeNumberOrInfVector("X", default = -1)
# throws exception with message defined by message and argumentName parameters
isStrictlyNegativeNumberOrInfVector(NULL, default = -1)
# returns -1 (the default, rather than the argument, since it is NULL)