Changelog • ospsuite.utils

ospsuite.utils 1.8.0

New functions using cli and logger packages to record and keep tracks of what the code does in a log file:
- setLogFolder(): initialize/end the logging system
- logCatch(): catch and record messages, warnings, and errors
- logError(), logWarning(), logInfo(), logDebug(): record errors, warnings, info and debug messages in the logs.

Class Printable is deprecated,
New functions ospPrintClass(), ospPrintItems(), and ospPrintHeader() are introduced to replace the Printable class.

Cloning method is now enabled for Printable R6 class. It is required to make some of child classes cloneable in dependent packages.

validateIsOption() to validate a list of options against specified criteria, improving robustness in option handling. This function ensures options match expected types, value ranges, allowed values, and handles NULL and NA values.
validateColumns() for rigorous validation of data frame columns against predefined specifications. Supports validation of type, value range, allowed values, and manages NULL and NA values effectively.
validateVector() introduced as a comprehensive vector validation tool, allowing checks against type, value range, and predefined allowed values with considerations for NULL and NA. Used by other validation functions validateIsOption() and validateColumns().
validateVectorRange() and validateVectorValues() to provide detailed validation for value ranges and allowed values respectively. These functions complement validateVector().
isFileUTF8() and validateIsFileUTF8() to provide validation assessing whether files are UTF-8 encoded.

logSafe() to compute logarithm of values that could be close to 0 or slightly negative.
foldSafe() to compute x / y when x or y could be negative or zero. All values below a certain threshold epsilon are substituted by epsilon. NOTE: not suited for calculating fold differences of negative numbers.

The print function of the Printable class now converts values using the format function before printing. E.g., numerical value “0.99999999” will be displayed as “1”. https://github.com/Open-Systems-Pharmacology/OSPSuite.RUtils/issues/120

ifEqual() and ifIncluded() for conditional values.
flattenList() to flatten a list to an atomic vector of desired type.
toMissingOfType() to convert special constants (NULL, Inf, NA, etc.) to NA of desired type.

hasEmptyStrings() and validateHasOnlyNonEmptyStrings() to check for empty strings.
objectCount to count number of objects.
validateHasOnlyDistinctValues() to validate only unique values are present.
validateIsFileExtension() to validate file extensions.
Cloning method is now disabled for Printable R6 class. This entails that cloneable property set by Printable’s subclasses will be respected. Previously, this was not the case; the cloning method was available even if the subclass had explicitly set cloneable = FALSE.

CRAN release: 2022-02-18

Removes alias hasUniqueValues().
All messages used in ospsuite package are now in ospsuit.utils (exported list messages).
Adds isEmpty() and validateIsNotEmpty() functions to validate that objects aren’t empty (#58; thanks to @pchelle).
Adds getOSPSuiteUtilsSetting() function to get global settings (see enum ospsuiteUtilsSettingNames for supported settings).

Fixes a regression in isIncluded() in previous release that inadvertently removed support for compound types (#63).

CRAN release: 2022-02-09

Improvements to documentation.
validateIsCharacter() is added as an alias for validateIsString() function.
getEnumKey() is added as an alias for enumGetKey() function.
hasOnlyDistinctValues() is added as an alias for hasUniqueValues() function.
validateIsInteger() now works with lists (#21).

CRAN release: 2021-12-08