Function reference
-
enum()
- Define an enumerated list
-
enumGetKey()
getEnumKey()
- 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
-
hasEmptyStrings()
validateHasOnlyNonEmptyStrings()
- Validate that no empty string is present
-
hasOnlyDistinctValues()
validateHasOnlyDistinctValues()
- Validate that a vector has only unique values
-
isEmpty()
validateIsNotEmpty()
- Validate if the provided object is empty
-
isFileExtension()
validateIsFileExtension()
- Validate if the provided path has required extension
-
isFileUTF8()
- Assess if a file is UTF-8 encoded.
-
isIncluded()
validateIsIncluded()
- Check if a vector of values is included in another vector of values
-
isOfLength()
validateIsOfLength()
- Check if the provided object has expected length
-
isOfType()
- Check if the provided object is of certain type
-
isSameLength()
validateIsSameLength()
- Validate if objects are of same length
-
isUTF8()
- Assess if a character vector is UTF-8 encoded.
-
validateColumns()
- Validate Data Frame Columns Against Specified Validations
-
validateEnumValue()
- Check if
value
is in the givenenum
. If not, stops with an error.
-
validateIsFileUTF8()
- Validate if a file is UTF-8 encoded.
-
validateIsOfType()
validateIsCharacter()
validateIsString()
validateIsNumeric()
validateIsInteger()
validateIsLogical()
- Check if the provided object is of certain type. If not, stop with an error.
-
validateIsOption()
- Validate Options Against Specified Valid Options
-
validatePathIsAbsolute()
- Check if path is absolute
-
validateVector()
validateVectorRange()
validateVectorValues()
- Validate Vector Against Specified Criteria
-
ifEqual()
- Value conditional on equality
-
ifIncluded()
- Value conditional on inclusion
-
ifNotNull()
- Value conditional on
NULL
-
formatNumerics()
- formatNumerics
-
Printable
- Printable
-
`%||%`
- Default value for
NULL
-
toList()
- Make sure the object is a list
-
toMissingOfType()
- Convert special constants to
NA
of desired type
-
messages
- List of functions and strings used to signal error messages
-
objectCount()
- Count number of objects
-
flattenList()
- Flatten a list to an atomic vector of desired type
-
logSafe()
- Computes logarithm of a number or of a vector of numbers and handles zeros while
substituting all values below
epsilon
byepsilon
.
-
foldSafe()
- Safe fold calculation
-
logSafe()
- Computes logarithm of a number or of a vector of numbers and handles zeros while
substituting all values below
epsilon
byepsilon
.
-
getOSPSuiteUtilsSetting()
- Get the value of a global ospsuite.utils package setting.
-
ospsuiteUtilsSettingNames
- Names of the settings stored in
ospsuiteEnv
. Can be used withgetOSPSuiteUtilsSetting()