toDisplayUnit: Convert base unit to display unit

View source: R/utilities-units.R

toDisplayUnitR Documentation

Convert base unit to display unit

Description

Converts a value given in base unit of a quantity into the display unit of a quantity

Usage

toDisplayUnit(quantity, values)

Arguments

quantity

Instance of a quantity from which the base unit will be retrieved

values

Value in base unit (single or vector)

Examples

simPath <- system.file("extdata", "simple.pkml", package = "ospsuite")
sim <- loadSimulation(simPath)
par <- getParameter("Organism|Liver|Volume", sim)

# Converts the value in base unit (1L) to display unit
valueInMl <- toDisplayUnit(par, 1)

valuesInDisplayUnit <- toDisplayUnit(par, c(1, 5, 5))

Open-Systems-Pharmacology/OSPSuite-R documentation built on Feb. 14, 2025, 4:48 p.m.