Package: ospsuite.utils 1.11.1

Michael Sevestre

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

A collection of utility functions for R packages in the Open Systems Pharmacology ecosystem. Contains helper functions for working with R6 objects, enumerated lists, and text formatting. Additionally, it provides functions to validate argument inputs.

Authors:Open-Systems-Pharmacology Community [cph, fnd], Michael Sevestre [aut, cre], Pavel Balazki [aut], Juri Solodenko [aut], Indrajeet Patil [aut]

ospsuite.utils_1.11.1.tar.gz
ospsuite.utils_1.11.1.zip(r-4.7)ospsuite.utils_1.11.1.zip(r-4.6)ospsuite.utils_1.11.1.zip(r-4.5)
ospsuite.utils_1.11.1.tgz(r-4.6-any)ospsuite.utils_1.11.1.tgz(r-4.5-any)
ospsuite.utils_1.11.1.tar.gz(r-4.7-any)ospsuite.utils_1.11.1.tar.gz(r-4.6-any)
ospsuite.utils_1.11.1.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
ospsuite.utils/json (API)

# Install 'ospsuite.utils' in R:

install.packages('ospsuite.utils', repos = c('https://open-systems-pharmacology.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/open-systems-pharmacology/ospsuite.rutils/issues

Pkgdown/docs site:https://www.open-systems-pharmacology.org

On CRAN:

5.19 score 2 stars 10 scripts 11 downloads 76 exports 11 dependencies

Last updated from:6d22617df4 (on v1.11.1). Checks:9 OK. Indexed: yes.

Target	Result	Time
linux-devel-x86_64	OK	142
source / vignettes	OK	207
linux-release-x86_64	OK	141
macos-release-arm64	OK	196
macos-oldrel-arm64	OK	182
windows-devel	OK	99
windows-release	OK	87
windows-oldrel	OK	108
wasm-release	OK	112

Exports:characterOption cliFormat enum enumGetKey enumGetValue enumHasKey enumKeys enumPut enumRemove enumValues flattenList foldSafe formatNumerics getEnumKey getLogFolder getOSPSuiteUtilsSetting hasEmptyStrings hasOnlyDistinctValues ifEqual ifIncluded ifNotNull integerOption isEmpty isFileExtension isFileUTF8 isIncluded isOfLength isOfType isPathAbsolute isSameLength isUTF8 logCatch logDebug logError logicalOption logInfo logSafe logWarning messages numericOption objectCount ospPrintClass ospPrintHeader ospPrintItems ospsuiteUtilsSettingNames Printable setErrorMasking setInfoMasking setLogFolder setWarningMasking tic timeStamp toc toList toMissingOfType validateEnumValue validateHasOnlyDistinctValues validateHasOnlyNonEmptyStrings validateIsCharacter validateIsFileExtension validateIsFileUTF8 validateIsIncluded validateIsInteger validateIsLogical validateIsNotEmpty validateIsNumeric validateIsOfLength validateIsOfType validateIsOption validateIsPathAbsolute validateIsSameLength validateIsString validatePathIsAbsolute validateVector validateVectorRange validateVectorValues

Dependencies:cli crayon glue lifecycle logger magrittr purrr R6 rlang stringi vctrs

Validating Options

Rendered fromvalidation-options.Rmdusingknitr::rmarkdown

Last update: 2025-10-28
Started: 2025-10-28

Logging utils

Get started | Taking advantage of glue and cli formatting | Catching messages | Masking messages

Rendered fromlogger.Rmdusingknitr::rmarkdown

Last update: 2025-07-25
Started: 2025-07-25

Citation

Development and contributors

Readme and manuals

Help Manual

Help page	Topics
Create Character Option Specification	characterOption
cliFormat	cliFormat
Define an enumerated list	enum
Get the key mapped to the given value in an 'enum'	enumGetKey getEnumKey
Get enum values	enumGetValue
Check if an enum has a certain key.	enumHasKey
Get all keys of an enum	enumKeys
Add a new key-value pairs to an 'enum'	enumPut
Remove an entry from the enum.	enumRemove
Get the values stored in an enum	enumValues
Flatten a list to an atomic vector of desired type	flattenList
Safe fold calculation	foldSafe
formatNumerics	formatNumerics
getLogFolder	getLogFolder
Get the value of a global '{ospsuite.utils}' package setting.	getOSPSuiteUtilsSetting
Validate that no empty string is present	hasEmptyStrings validateHasOnlyNonEmptyStrings
Validate that a vector has only unique values	hasOnlyDistinctValues validateHasOnlyDistinctValues
Value conditional on equality	ifEqual
Value conditional on inclusion	ifIncluded
Value conditional on 'NULL'	ifNotNull
Create Integer Option Specification	integerOption
Validate if the provided object is empty	isEmpty validateIsNotEmpty
Validate if the provided path has required extension	isFileExtension validateIsFileExtension
Assess if a file is UTF-8 encoded.	isFileUTF8
Check if a vector of values is included in another vector of values	isIncluded validateIsIncluded
Check if the provided object has expected length	isOfLength validateIsOfLength
Check if the provided object is of certain type	isOfType
Check if path is absolute	isPathAbsolute validateIsPathAbsolute validatePathIsAbsolute
Validate if objects are of same length	isSameLength validateIsSameLength
Assess if a character vector is UTF-8 encoded.	isUTF8
logCatch	logCatch
logDebug	logDebug
logError	logError
Create Logical Option Specification	logicalOption
logInfo	logInfo
Computes logarithm of a number or of a vector of numbers and handles zeros while substituting all values below 'epsilon' by 'epsilon'.	logSafe
logWarning	logWarning
List of functions and strings used to signal error messages	messages
Create Numeric Option Specification	numericOption
Count number of objects	objectCount
Print an object's class name	ospPrintClass
Print a header with specified level	ospPrintHeader
Print a list of items with an optional title	ospPrintItems
Names of the settings stored in 'ospsuiteEnv'. Can be used with 'getOSPSuiteUtilsSetting()'	ospsuiteUtilsSettingNames
Printable	Printable
setErrorMasking	setErrorMasking
setInfoMasking	setInfoMasking
setLogFolder	setLogFolder
setWarningMasking	setWarningMasking
tic	tic
timeStamp	timeStamp
toc	toc
Make sure the object is a list	toList
Convert special constants to 'NA' of desired type	toMissingOfType
Check if 'value' is in the given 'enum'. If not, stops with an error.	validateEnumValue
Validate if a file is UTF-8 encoded.	validateIsFileUTF8
Check if the provided object is of certain type. If not, stop with an error.	validateIsCharacter validateIsInteger validateIsLogical validateIsNumeric validateIsOfType validateIsString
Validate Options Against Specifications	validateIsOption
Validate Vector Against Specified Criteria	validateVector validateVectorRange validateVectorValues