formatNumerics: formatNumerics

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

formatNumerics

Description

Render numeric values of an object as character using the specified format:

• If object is a data.frame or a list, formatNumerics applies on each of its fields

• If object is of type character or integer, formatNumerics renders the values as is

• If object is of type numeric, formatNumerics applies the defined format

Usage

formatNumerics(
  object,
  digits = ospsuiteUtilsEnv$formatNumericsDigits,
  scientific = FALSE
)

Arguments

object	An R object such as a list, a data.frame, character or numeric values.
digits	Number of decimal digits to render
scientific	Logical value defining if scientific writing is rendered

Value

Numeric values are rendered as character values. If object is a data.frame or a list, a data.frame or list is returned with numeric values rendered as character values.

Examples

# Format array of numeric values
formatNumerics(log(c(12, 15, 0.3)), digits = 1, scientific = TRUE)

# Format a data.frame
x <- data.frame(parameter = c("a", "b", "c"), value = c(1, 110.4, 6.666))
formatNumerics(x, digits = 2, scientific = FALSE)

ospsuite.utils documentation built on March 18, 2022, 6:44 p.m.