clinUtils (version 0.1.4)

roundHalfUpTextFormat: Round a number with 'round-up' strategy for rounding off a 5 in text format

Description

This function rounds numbers with a 'round-up' strategy for rounding off a 5. The function rounds for a specified number of digits and format number to a: 'xxx.xxx' text.

Usage

roundHalfUpTextFormat(x, digits = 0)

Value

A character vector with the rounded number. NA values are returned as 'NA' as string.

Arguments

x

Numeric vector to round.

digits

Integer with number of digits to consider, 0 by default.

Author

Laure Cougnaud and Michela Pasetto

Details

The following workflow is used:

1. numbers are rounded with the roundHalfUp function, see the ? roundHalfUp for more details on the rounding strategy

2. round numbers are formatted to character in the format: 'xxx.xxx' with pads leading zeros

See Also

roundHalfUp for the rounding customization.

Examples

# number of digits higher than number of decimal
roundHalfUpTextFormat(x = c(0.345, 0.567, -0.98), digits = 2)
# number of digits lower than number of decimal
roundHalfUpTextFormat(x = c(0.345, 0.567, -0.98), digits = 0)
# by default, 'digits' is 0!
roundHalfUpTextFormat(x = c(0.345, 0.567, -0.98))
# padding zeros
roundHalfUpTextFormat(1.23, 10)