validateIsOfType: Check if the provided object is of certain type. If not, stop...

In ospsuite.utils: Utility Functions for Open Systems Pharmacology R Packages

Check if the provided object is of certain type. If not, stop with an error.

Description

Check if the provided object is of certain type. If not, stop with an error.

Usage

validateIsOfType(object, type, nullAllowed = FALSE)

validateIsCharacter(object, nullAllowed = FALSE)

validateIsString(object, nullAllowed = FALSE)

validateIsNumeric(object, nullAllowed = FALSE)

validateIsInteger(object, nullAllowed = FALSE)

validateIsLogical(object, nullAllowed = FALSE)

Arguments

object	An object or an atomic vector or a list of objects.
type	A single string or a vector of string representation or class of the type that should be checked for.
nullAllowed	Boolean flag if NULL is accepted for the object. If TRUE, NULL always returns TRUE, otherwise NULL returns FALSE. Default is FALSE.

Value

NULL if the entered object is of expected type, otherwise produces error. Also accepts NULL as an input if nullAllowed argument is set to TRUE.

Examples

A <- data.frame(
  col1 = c(1, 2, 3),
  col2 = c(4, 5, 6),
  col3 = c(7, 8, 9)
)

validateIsOfType(A, "data.frame")
validateIsInteger(5)
validateIsNumeric(1.2)
validateIsCharacter("x")
validateIsLogical(TRUE)

ospsuite.utils documentation built on March 18, 2022, 6:44 p.m.