Utility Functions for Open Systems Pharmacology R Packages

[Up] [Top]

Documentation for package ‘ospsuite.utils’ version 1.2.0

Help Pages

%||% Default value for 'NULL'
enum Define an enumerated list
enumGetKey Get the key mapped to the given value in an 'enum'
enumGetValue Get enum values
enumHasKey Check if an enum has a certain key.
enumKeys Get all keys of an enum
enumPut Add a new key-value pairs to an 'enum'
enumRemove Remove an entry from the enum.
enumValues Get the values stored in an enum
formatNumerics formatNumerics
getEnumKey Get the key mapped to the given value in an 'enum'
getOSPSuiteUtilsSetting Get the value of a global '{ospsuite.utils}' package setting.
hasOnlyDistinctValues Check that an array of values does not include any duplicate
ifNotNull Shortkey checking if argument 1 is not 'NULL', output the argument 2 if not null, or output argument 3 otherwise
isEmpty Check if the provided object is empty
isFileExtension Check if the provided path has required extension
isIncluded Check if a vector of values is included in another vector of values
isOfLength Check if the provided object has 'nbElements' elements
isOfType Check if the provided object is of certain type
isSameLength Check if objects are of same length
messages List of functions and strings used to signal error messages
op-null-default Default value for 'NULL'
ospsuiteUtilsSettingNames Names of the settings stored in 'ospsuiteEnv'. Can be used with 'getOSPSuiteUtilsSetting()'
Printable Printable
toList Make sure the object is a list
validateEnumValue Check if 'value' is in the given 'enum'. If not, stops with an error.
validateIsCharacter Check if the provided object is of certain type. If not, stop with an error.
validateIsIncluded Check if values are included
validateIsInteger Check if the provided object is of certain type. If not, stop with an error.
validateIsLogical Check if the provided object is of certain type. If not, stop with an error.
validateIsNotEmpty Check if objects is not empty
validateIsNumeric Check if the provided object is of certain type. If not, stop with an error.
validateIsOfLength Check if objects have expected length
validateIsOfType Check if the provided object is of certain type. If not, stop with an error.
validateIsSameLength Check if all objects are of same length
validateIsString Check if the provided object is of certain type. If not, stop with an error.
validatePathIsAbsolute Check if path is absolute